User Guide

632 Chapter 3: ColdFusion Functions

GetSOAPRequestHeader

Description

Obtains a SOAP request header. Call only from within a CFC web service function that is

processing a request as a SOAP web service.

Returns

A SOAP request header.

See also

AddSOAPRequestHeader

, AddSOAPResponseHeader, GetSOAPRequest, GetSOAPResponse,

GetSOAPResponseHeader, IsSOAPRequest; “Basic web service concepts” in Chapter 36, “Using

Web Services,” in ColdFusion MX Developer’s Guide

Parameters

Usage

If you specify False for the asXML parameter, ColdFusion first attempts to retrieve the header

using the data type specified in the header’s

xsi:type attribute. If the xsi:type attribute is not

available, ColdFusion attempts to retrieve the header as a string. If you specify True for the

asXML

parameter, ColdFusion retrieves the header as raw XML.

This function throws an error if it is invoked in a context that is not a web service request. Use the

IsSOAPRequest function to determine whether the CFC is running as a web service.

Example

This example creates a CFC web service that illustrates the operation of the

GetSOAPRequestHeader function and also provides a web service that illustrates the operation of

other ColdFusion SOAP functions.

Save the following code as headerservice.cfc in a folder called soapheaders under your web root.

Test its operation, and specifically the operation of the

GetSOAPRequestHeader function, by

executing the examples that invoke this web service. For example, see the example for

AddSOAPRequestHeader.

Parameter Description

namespace A String that is the namespace for the header.

name A String that is the name of the header.

asXML If True, the header is returned as a CFML XML object; if False (default), the header

is returned as a Java object.