Share via

3.11.4.1.5 IsOpen (Opnum 11)

  • Article

The IsOpen method is received by the server in an RPC_REQUEST packet. In response, the server returns a value that indicates whether the queue is open.

 [propget] HRESULT IsOpen(
   [out, retval] short* pisOpen
 );

pisOpen: A pointer to a short that MUST be set to TRUE (0x0001) if the queue is open and FALSE (0x0000) if the queue is closed.

Return Values: The method MUST return S_OK (0x00000000) on success or an implementation-specific error HRESULT on failure.

When processing this call, the server MUST follow these guidelines:

  • If the IsInitialized instance variable is False:

    • Return an error OLE_E_BLANK (0x80040007), and take no further action.

  • If the IsClosed instance variable equals True:

    • Set the pisOpen output variable to FALSE (0x0000).

  • Else:

    • Set the pisOpen output variable to TRUE (0x0001).

  • Return S_OK (0x00000000), and take no further action.