PROPID_M_SOAP_ENVELOPE (Compact 2013)
3/26/2014
This property provides the SOAP envelope of an HTTP message and does not include binary attachments.
- Property ID
PROPID_M_SOAP_ENVELOPE
- Type Indicator
VT_LPWSTR
- MQPROPVARIANT Field
pwszVal
- Property Values
A string of Unicode characters containing the SOAP envelope from the message.
Remarks
The PROPID_M_SOAP_ENVELOPE property is a read-only property that is only used when reading HTTP messages.
When an HTTP message is sent, the sending queue manager attaches the SOAP envelope, along with SOAP attachments, to the message. The SOAP envelope consists of a body and a header.
After the receiving application retrieves this property, the application can parse the envelope to obtain specific SOAP body and header elements.
To retrieve the entire contents of an HTTP message in the form of an array of bytes, including the SOAP envelope and the SOAP attachments associated with it, use the PROPID_M_COMPOUND_MESSAGE property.
Equivalent COM Property
With COM components, the equivalent property is MSMQMessage.SOAPEnvelope.
Examples
The following code example shows how PROPID_M_SOAP_ENVELOPE is specified in the MQMSGPROPS structure for retrieving the SOAP envelope. The length of the SOAP envelope must be retrieved with the SOAP envelope.
Important
For readability, the following code example does not contain security checking or error handling. Do not use the following code in a production environment.
MsgProps.aPropID[i] = PROPID_M_SOAP_ENVELOPE_LEN;
MsgProps.aPropVar[i].vt = VT_UI4;
i++;
MsgProps.aPropID[i] = PROPID_M_SOAP_ENVELOPE;
MsgProps.aPropVar[i].vt = VT_LPWSTR;
aMsgPropVar[i].pwszVal = wszSOAPEnvelopeBuffer;
i++;