PROPID_M_SOAP_BODY (Compact 2013)
3/26/2014
This property specifies additional application-generated body elements for inclusion in the SOAP envelope of an HTTP message.
- Property ID
PROPID_M_SOAP_BODY
- Type Indicator
VT_LPWSTR
- MQPROPVARIANT Field
pwszVal
- Property Values
A string of Unicode characters containing XML body elements for inclusion in the SOAP envelope of the HTTP message.
Remarks
The PROPID_M_SOAP_BODY property is a write-only property that is used only when an application sends HTTP messages.
When an HTTP message is sent, the sending queue manager appends the string of additional SOAP body elements specified in this property to the end of the Message Queuing-generated SOAP body portion of the SOAP envelope in the message. It then attaches the SOAP envelope and, when applicable, 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 HTTP message.
To set additional application-generated SOAP body elements, specify PROPID_M_SOAP_BODY in the MQMSGPROPS structure and call MQSendMessage.
To set additional application-generated SOAP header elements in the SOAP envelope, use the PROPID_M_SOAP_HEADER property.
To retrieve the complete SOAP envelope, use the PROPID_M_SOAP_ENVELOPE property.
To retrieve the contents of an HTTP message in the form of an array of bytes, including both the SOAP envelope and the SOAP attachments associated with it, use the PROPID_M_COMPOUND_MESSAGE property.
To set or retrieve the message body, which is sent as an attachment in an HTTP message, use the PROPID_M_BODY property.
Equivalent COM Property
With COM components, the equivalent property is MSMQMessage.SOAPBody.
Examples
The following code example shows how PROPID_M_SOAP_BODY is specified in the MQMSGPROPS structure for setting additional application-generated SOAP body elements.
aMsgPropId[i] = PROPID_M_SOAP_BODY; // Property ID.
aMsgPropVar[i].vt = VT_LPWSTR; // Type indicator.
aMsgPropVar[i].pwszVal = wszSoapBodyBuffer;
i++;