3.3.4.1.2 FormatName (Opnum 8)

  • Article

The FormatName method is received by the server in an RPC_REQUEST packet. In response, the server MUST return the format name of the represented Queue.

 [propget] HRESULT FormatName(
   [out, retval] BSTR* pbstrFormatName
 );

pbstrFormatName: A pointer to a BSTR that, when successfully completed, contains the format name of the represented Queue.

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

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

  • If the ObjectIsInitialized instance variable is False, return MQ_ERROR_UNINITIALIZED_OBJECT (0xC00E0094) and take no further action.

  • Set the pbstrFormatName output variable to the value of the QueueFormatName instance variable.