3.4.4.1.1 JournalMessageCount (Opnum 16)

The JournalMessageCount method is received by the server in an RPC_REQUEST packet. In response, the server MUST return the number of messages in the Queue that is associated with the represented Queue.JournalQueueReference.

 [propget] HRESULT JournalMessageCount(
   [out, retval] long* plJournalMessageCount
 );

plJournalMessageCount: A pointer to a long that, when successfully completed, contains the number of messages in the Queue that is associated with the represented Queue.JournalQueueReference.

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 ObjectIsInitialized instance variable is False:

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

  • The server MUST generate a QMMgmt Get Info event with the following inputs:

    • iPropID = PROPID_MGMT_QUEUE_JOURNAL_MESSAGE_COUNT

    • If the rStatus return value is not equal to MQ_OK (0x00000000), the server MUST return rStatus and MUST take no further action.

    • Else:

      • The plJournalMessageCount output variable MUST be set to the value of the returned rPropVar.