MSMQMessage.SoapEnvelope

 

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 SoapEnvelope property of the MSMQMessage object provides the SOAP envelope (not including binary attachments) attached to an SRMP message.

Data type:	String
Run-time access:	Read-only

Property SoapEnvelope As String  

Property Value

A String of Unicode characters that represents the SOAP envelope.

Remarks

SoapEnvelope is used only when retrieving SRMP messages. When an SRMP message is sent, the sending queue manager attaches the SOAP envelope, along with any SOAP attachments, to the message. The SOAP envelope consists of a body and a header.

After the receiving application retrieves this property, it can parse it to obtain specific SOAP body and header elements.

To retrieve the entire contents of an SRMP message in the form of an array of bytes, including both the SOAP envelope and the SOAP attachments associated with it, use the MSMQMessage.CompoundMessage property.

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

Equivalent API Function Property

With API function calls, the equivalent property is PROPID_M_SOAP_ENVELOPE.

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.CompoundMessage
PROPID_M_SOAP_ENVELOPE