MSMQMessage.CompoundMessage

 

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

(Introduced in MSMQ 3.0.) The CompoundMessage property of the MSMQMessage object provides the entire contents of an SRMP message, including the SOAP envelope and the SOAP attachments associated with it.

Data type:	Variant (array of bytes)
Run-time access:	Read-only

Property CompoundMessage As Variant  

Property Value

A Variant containing an array of bytes that represents the entire contents of an SRMP message, including both the SOAP envelope and the SOAP attachments (MIME binary attachments) associated with it.

Remarks

CompoundMessage is used only when an application retrieves SRMP messages. When an SRMP message is sent, the sending queue manager attaches the SOAP attachments, along with the SOAP envelope, to the message.

This property can contain any number of SOAP attachments. It is the responsibility of the receiving application to parse the returned array of bytes, and to process the envelope and the individual attachments to retrieve individual elements. Any XML parser can be used for this purpose.

To retrieve the SOAP envelope, use the MSMQMessage.SoapEnvelope property.

To retrieve the message body, which is sent as an attachment in an SRMP message, use the MSMQMessage.Body property.

In C++ COM applications, you must use a smart pointer to the IMSMQMessage3 interface to expose the CompoundMessage property.

Equivalent API Function Property

With API function calls, the equivalent property is PROPID_M_COMPOUND_MESSAGE.

Requirements

Windows NT/2000/XP: Included in Windows XP and Windows Server 2003

Windows 95/98/Me: Unsupported.

Header: Declared in Mqoai.h.

Library: Use Mqoa.lib

See Also

MSMQMessage
MSMQMessage.SoapBody
MSMQMessage.SoapEnvelope
PROPID_M_COMPOUND_MESSAGE