3.17.4.1.23 AdminQueueInfo_v1 (Opnum 29)

  • Article

The AdminQueueInfo_v1 method is received by the server in an RPC_REQUEST packet. In response, the server MUST return an IMSMQQueueInfo interface pointer to an MSMQQueueInfo object that represents the Queue that is identified by the represented Message.AdministrationQueueFormatName.

 HRESULT AdminQueueInfo_v1(
   [out, retval] IMSMQQueueInfo** ppqinfoAdmin
 );

ppqinfoAdmin: A pointer to an IMSMQQueueInfo interface pointer that upon successful completion will contain an MSMQQueue object representing the queue that will receive the administration messages sent by the system.

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:

  • Create a new MSMQQueueInfo object instance.

  • Set the QueueFormatName instance variable of the created MSMQQueueInfo object to the value of the represented Message.AdministrationQueueFormatName.

  • Call MSMQQueueInfo::Refresh on the created MSMQQueueInfo instance.

  • Set the ppqinfoAdmin output parameter to a pointer to an IMSMQQueueInfo interface for the newly created MSMQQueueInfo object.