PROPID_M_SOAP_HEADER (Compact 2013)

  • Article

3/26/2014

This property specifies additional application-generated header elements for inclusion in the SOAP envelope of an HTTP message.

  • Property ID
    PROPID_M_SOAP_HEADER
  • Type Indicator
    VT_LPWSTR
  • MQPROPVARIANT Field
    pwszVal
  • Property Values
    A string of Unicode characters specifying well-formed XML header elements for inclusion in the SOAP envelope of the HTTP message.

Remarks

The PROPID_M_SOAP_HEADER property is a write-only property used only when an application sends HTTP messages.

When an HTTP message is sent, the sending queue manager appends the string of additional SOAP header elements specified in this property to the end of the Message Queuing-generated SOAP header portion of the SOAP envelope in the message. It then attaches the SOAP envelope and, when applicable, SOAP attachments to the message.

Unlike Windows XP, the string supplied to this property is not validated to verify if it contains only well-formed XML elements. The string is passed on to the SRMP server without error checking.

To set additional application-generated SOAP header elements, specify PROPID_M_SOAP_HEADER in the MQMSGPROPS structure and call MQSendMessage.

To set additional application-generated SOAP body elements in the SOAP envelope, use the PROPID_M_SOAP_BODY 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.

Equivalent COM Property

With COM components, the equivalent property is MSMQMessage.SOAPHeader.

Examples

The following code example shows how PROPID_M_SOAP_HEADER is specified in the MQMSGPROPS structure for setting additional application-generated SOAP header elements.

aMsgPropId[i] = PROPID_M_SOAP_HEADER;       // Property ID.
aMsgPropVar[i].vt = VT_LPWSTR;              // Type indicator.
aMsgPropVar[i].pwszVal = wszSoapHeaderBuffer;
i++;

See Also

Reference

MSMQ Properties
MQSendMessage
MQMSGPROPS
PROPID_M_SOAP_BODY
PROPID_M_SOAP_ENVELOPE