3.5.4.1.5 Pause (Opnum 20)

  • Article

The Pause method is received by the server in an RPC_REQUEST packet. In response, the server MUST pause the transmission of messages from the referenced OutgoingQueue.

 HRESULT Pause();

This method has no parameters.

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

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

  • If the ObjectIsInitialized instance variable is False:

    • The server MUST return MQ_ERROR_UNINITIALIZED_OBJECT (0xC00E0094), and take no further action.

  • The server MUST generate a QMMgmtAction event with the following inputs:

    • iAction = "Pause"

  • The server MUST return rStatus, and take no further action.