Properties Mapped to Elements of the MSMQ Namespace
Applies To: Windows 10, Windows 7, Windows 8, Windows 8.1, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2, Windows Server Technical Preview, Windows Vista
The following Message Queuing message properties are mapped to elements of the MSMQ namespace and are included as elements of the <Msmq> entry in the order in which they are listed. A separate namespace is declared as a default namespace (without a prefix) for the <Msmq> element and the other elements used within its context:
- <Class>
(Required, read-only.) Indicates whether the message is a normal message, an acknowledgment message, or a report message. (PROPID_M_CLASS or MSMQMessage.MsgClass). For acknowledgment messages, the numerical value contained in this element can indicate whether the message arrived at the destination queue, whether it was retrieved, why it did not arrive, or why it was not retrieved.
- <Priority>
(Required, read/write.) Specifies the priority level of the message (PROPID_M_PRIORITY or MSMQMessage.Priority).
- <Journal/>
(Optional, read/write.) Indicates that positive source journaling is requested (PROPID_M_JOURNAL or MSMQMessage.Journal set to MQMSG_JOURNAL or MQMSG_JOURNAL | MQMSG_DEADLETTER). When this element is included, a copy of the message is stored in the computer journal on the computer if the message is successfully delivered to the next computer. If a <DeadLetter/> element is also included, a copy of the message is stored in the computer journal on successful delivery to the next computer or the message is moved to the applicable dead-letter queue on failure before retrieval.
- <DeadLetter/>
(Optional, read/write.) Indicates that negative source journaling is requested (PROPID_M_JOURNAL or MSMQMessage.Journal set to MQMSG_DEADLETTER or MQMSG_JOURNAL | MQMSG_DEADLETTER). When this element is included, the message is moved to the applicable dead-letter queue on failure. For nontransactional messages, failure means, for example, that the message was not delivered to the next computer before the date and time specified in the <expiresAt> element of the mandatory <properties> header entry, that is, before expiration of the message's time-to-reach-queue timer. For transactional messages, failure means, for example, that the source queue manager did not receive a confirmation that the message was removed from its destination queue before the time set in the <TTrq> element of the <Msmq> entry. If a <Journal/> element is also included, a copy of the message is stored in the computer journal on the computer if the message is successfully delivered to the next computer.
- <Correlation>
(Optional, read/write.) Specifies the 20-byte application-generated correlation identifier of the message (PROPID_M_CORRELATIONID or MSMQMessage.CorrelationId).
- <App>
(Optional, read/write.) Specifies application-specific information (PROPID_M_APPSPECIFIC or MSMQMessage.AppSpecific).
- <BodyType>
(Required, read/write.) Indicates the type of data contained in the message body (PROPID_M_BODY_TYPE).
- <HashAlgorithm>
(Optional, read/write.) Specifies the hashing algorithm that Message Queuing uses when authenticating the message (PROPID_M_HASH_ALG or MSMQMessage.HashAlgorithm).
- <ConnectorId>
(Optional, read-only.) Specifies the identifier (GUID) of the connector queue manager.
- <Eod>
(Optional, read-only.) Outer element for exactly-once-delivery (EOD) information that may contain <First/> and <Last/> as subelements.
- <First/>
(Optional subelement of <Eod>, read-only.) Indicates that the message is the first message in the transaction (PROPID_M_FIRST_IN_XACT set to MQMSG_FIRST_IN_XACT or MSMQMessage.IsFirstInTransaction2 set to True).
- <Last/>
(Optional subelement of <Eod>, read-only.) Indicates that the message is the last message in the transaction (PROPID_M_LAST_IN_XACT set to MQMSG_LAST_IN_XACT or MSMQMessage.IsLastInTransaction2 set to True).
- <Provider>
(Optional.) Outer element that contains <Type> and <Name> as subelements.
- <Type>
(Required subelement of <Provider>, read/write.) The type of cryptographic provider used to generate the digital signature of the message (PROPID_M_PROV_TYPE or MSMQMessage.AuthenticationProviderType).
- <Name>
(Required subelement of <Provider>, read/write.) The name of the cryptographic provider used to generate the digital signature of the message (PROPID_M_PROV_NAME or MSMQMessage.AuthenticationProviderName).
- <SourceQmGuid>
(Required, read-only.) Specifies the identifier (GUID) of the computer where the message originated (PROPID_M_SRC_MACHINE_ID or MSMQMessage.SourceMachineGuid).
- <DestinationMqf>
(Optional, read/write.) Specifies the format name of the destination queue or queues to which the message is sent (PROPID_M_DEST_FORMAT_NAME or MSMQMessage.Destination). The string may contain a public, private, direct, distribution list, or multiple-element format name.
- <AdminMqf>
(Optional, read/write.) Specifies the HTTP direct format name of the administration queue to which acknowledgment messages are sent (PROPID_M_ADMIN_QUEUE or MSMQMessage.AdminQueueInfo). The string may contain a single-element format name.
- <ResponseMqf>
(Optional, read/write.) Specifies the format name of the queue or queues to which a response message is sent (PROPID_M_RESP_FORMAT_NAME or MSMQMessage.ResponseDestination). The string may contain a public, private, direct, distribution list, or multiple-element format name.
- <TTrq>
(Required, read/write.) Specifies the date and time until which the message may be stored in the destination queue (the absolute UTC date and time calculated from the relative time specified in PROPID_M_TIME_TO_BE_RECEIVED or MSMQMessage.MaxTimeToReceive). The string included in this element specifies the date and time in the form yyyymmddTseconds.
The following example shows how many of these properties are included in an HTTP message as elements of an <Msmq> header entry:
<Msmq xmlns="msmq.namespace.xml">
<Class>0</Class>
<Priority>0</Priority>
<DeadLetter/>
<Correlation>ABCDABCDABCDABCDABCDABCDABCDABCDABCDABCD</Correlation>
<App>0</App>
<BodyType>8</BodyType>
<HashAlgorithm>32772</HashAlgorithm>
<Eod><First/><Last/></Eod>
<SourceQmGuid>bb270336-75e0-426f-9a73-e1ac49204e05</SourceQmGuid>
<TTrq>20010829T162432</TTrq>
</Msmq>
More Information
| For information on | See |
|---|---|
| HTTP messages | HTTP Messages |
| The message properties that are mapped to WS-Routing elements | Properties Mapped to WS-Routing Elements |
| The message properties that are mapped to SRMP elements | Properties Mapped to SRMP Elements |