MSMQMessage.DestinationQueueInfo

A version of this page is also available for

4/8/2010

This read-only property specifies the destination queue of the message. It is set by Message Queuing when a message is sent.

Syntax

HRESULT get_DestinationQueueInfo( 
  MSMQQueueInfo** ppqinfoDest 
);

The following table describes the common return values.

Value	Description
S_OK	Success
E_INVALIDARG	One or more arguments are invalid
E_NOTIMPL	The function contains no implementation
E_OUTOFMEMORY	Out of memory

To retrieve the DestinationQueueInfo property of the message, set the WantDestinationQueue parameter of receive or peek methods to TRUE.

Receive or peek methods include the following:

For performance reasons, the default setting of WantDestinationQueue is FALSE.

DestinationQueueInfo is typically used in the following situations:

When reading messages that are sent to a queue other than the original destination queue.
For example, you might want to know the original destination queue of the messages that Message Queuing has sent to a computer journal or a dead-letter queue. Normally, you do not need this property because you read the message from its destination queue.
When sending response messages to a response queue.
To provide the destination queue of a message in a response message, set the MSMQMessage.ResponseQueueInfo property of the response message to the DestinationQueueInfo property of the original message.
The application reading the response message can then look at the response queue information property to determine the origin of the response message.

You can also retrieve the destination queue when using Message Queuing function calls.

For information on	See
Retrieving the destination queue using Message Queuing function calls	PROPID_M_DEST_QUEUE

Header	mqoai.h
Library	mqoa.lib
Windows Embedded CE	Windows CE .NET 4.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later