MSMQMessage.DestinationQueueInfo (Compact 2013)
3/26/2014
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
);
Parameters
- ppqinfoDest
Destination queue of the message.
Return Value
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 |
Remarks
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 |
Requirements
Header |
mqoai.h |
Library |
mqoa.lib |
See Also
Reference
MSMQMessage
MSMQMessage.ResponseQueueInfo
MSMQQueue.Peek
MSMQQueue.PeekCurrent
MSMQQueue.PeekNext
MSMQQueue.Receive
MSMQQueue.ReceiveCurrent
MSMQQueueInfo
PROPID_M_DEST_QUEUE