SoapHeaderRequestNode - cClientWebService

Returns SOAP header request information that was passed to a web service.

Type: Function
Return Data Type: Handle

Syntax

Function SoapHeaderRequestNode Returns Handle

Call Example

Get SoapHeaderRequestNode to HandleVariable

Description

The SoapHeaderRequestNode provides a low level mechanism for processing SOAP header information. After a web service has been invoked, a developer can call this method to return a handle to an XML document object containing the SOAP header data that was passed to the server. The object handle returned will be a handle to an XML document object (cXMLDomDocument) and represents the entire SOAP header XML node. The root node of this document will be the SOAP node and each child node should be an element node representing a header.

SOAP request headers are created using the ClearSoapHeaders and AddSoapHeaderNode methods. SoapHeaderRequestNode contains the results of this creation. Note that this method should only be used after the web service has been invoked.

It is the responsibility of the developer to destroy the XML object within the method that uses it.

This method will be rarely used, since the developer normally does not need to know anything about the request headers that they just created.

Return Value

Returns object handle of the XML object representing the SOAP request header that was passed in the last web service call.