3.10.4.1.9 FormatName (Opnum 15)

  • Article

The FormatName method is received by the server in an RPC_REQUEST packet. In response, the server sets the QueueFormatName instance variable, which contains the format name of the queue that will be referenced by the MSMQQueueInfo class. Setting this value does not change the format name of a queue, but rather changes which queue is referenced.

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

bstrFormatName: A BSTR that specifies the format name of the referenced queue.

Return Values: The method MUST return S_OK (0x00000000).

When processing this call, the server MUST abide by the following contract:

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

  • Set refQueue.PathName to NULL.

  • Set the IsRefreshed, IsApplicationQueue, and IsQueueCreated instance variables to FALSE.

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