GetStatus

VTS Functions > G Functions

GetStatus

(RPC Manager Library)

Description: This module returns a variable that holds the current service instance status for the specified service.

Returns: Numeric

Usage: Steady State or subroutine call

Format: \RPCManager\GetStatus(ServiceName [, OptGUID])

Parameters: ServiceName { text } { required } { no default }

Any text expression giving the name of the service for which to get the connection status.

OptGUID { text } { optional } { default: (see note) }

An optional parameter that provides the GUID of the application in which the service instance is located. The default is the application to which the caller belongs.

Comments: This module is a member of the RPC Manager's Library, and must therefore be prefaced by \RPCManager\, as shown in the "Format" section. If the application you are developing is a script application, the module call must be prefaced by System\RPCManager\, and the System variable must be declared in AppMod.src.

The return value from this subroutine is the current status of a service on the local workstation. It is similar to the return value for the Register module, except that in that case it is a pointer to the value that is returned rather than the value itself.

If the 16-byte binary format of the GUID is not known, the GetGUID module may be used to obtain it.

Example:

status = \RPCManager\GetStatus("EditLockoutManager");