MSMQMessage.SoapBody

  • Article

 

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 SoapBody property of the MSMQMessage object specifies application-generated SOAP body elements for inclusion in the SOAP envelope of an SRMP message.

Data type: String
Run-time access: Write-only 
Property SOAPBody As String

Property Value

A String of Unicode characters that represents XML body elements for inclusion in the SOAP envelope of the SRMP message.

Remarks

SoapBody is used only when an application sends SRMP messages. When an SRMP message is sent, the sending queue manager inserts the string of SOAP body elements specified in this property into the SOAP body portion of the SOAP envelope in the message. It then attaches the SOAP envelope, and when applicable, the SOAP attachments to the message.

The SOAP body, which is part of the SOAP envelope, is distinct from the application-defined message body, which is sent as an attachment to the SRMP message.

To set application-generated SOAP header elements in the SOAP envelope, use the MSMQMessage.SoapHeader property.

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

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.

To set or 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 SoapBody property.

Equivalent API Function Property

With API function calls, the equivalent property is PROPID_M_SOAP_BODY.

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.Body
MSMQMessage.CompoundMessage
MSMQMessage.SoapHeader
PROPID_M_SOAP_BODY