Share via

3.12.4.1.11 FormatName (Opnum 17)

  • Article

The FormatName method is received by the server in an RPC_REQUEST packet. In response, the server sets the QueueFormatName instance variable that contains the format name that identifies the Queues represented by this object.

 [propput] HRESULT FormatName(
   [in] BSTR bstrFormatName
 );

bstrFormatName: A BSTR that contains the format name of the queue or queues represented by the MSMQDestination object.

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:

  • Set the QueueFormatName instance variable to the bstrFormatName input parameter.

  • Set the QueuePathName instance variable to NULL.

  • Set the DirectoryPath instance variable to NULL.

  • If the DestinationOpenQueueDescriptor instance variable is not equal to NULL, reopen the object as follows:

    1. Call the MSMQDestination::Close method.

    2. Call the MSMQDestination::Open method.

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