The IsConnected method is received by the server in an RPC_REQUEST packet. In response, the server MUST return a BOOLEAN value that indicates the connection status of the represented QueueManager.
[propget] HRESULT IsConnected( [out, retval] VARIANT_BOOL* pfIsConnected );
pfIsConnected: A pointer to a VARIANT_BOOL that, when successfully completed, contains one of the following values.
|
Value |
Meaning |
|---|---|
|
VARIANT_TRUE 0xffff |
The represented QueueManager is connected to the network and the directory. |
|
VARIANT_FALSE 0x0000 |
The represented QueueManager is disconnected from the network and the directory. |
Return Values: The method MUST return S_OK (0x00000000) to indicate success or an implementation-specific error HRESULT on failure.
When the server processes this call, it MUST follow these guidelines:
If the ComputerName instance variable is NULL:
Set the pfIsConnected output variable to local QueueManager.ConnectionActive.
Else:
The server MUST generate a QMMgmt Get Info event with the following inputs:
iPropID = PROPID_MGMT_MSMQ_CONNECTED
If the rStatus return value is not equal to MQ_OK (0x00000000), the server MUST return rStatus and MUST take no further action. Otherwise, the pfIsConnected output variable MUST be set to the value of the returned rPropVar.