User Guide

ManualsBrandsMacromedia ManualsOtherFLASH MX 2004-ACTIONSCRIPT LANGUAGE REFERENCE

1011

1012 Chapter 2: ActionScript Language Reference

XML.addRequestHeader()

Availability

Flash Player 6.

Usage

my_xml.addRequestHeader(headerName:String, headerValue:String) : Void

my_xml.addRequestHeader(["headerName_1":String, "headerValue_1":String ...

"headerName_n":String, "headerValue_n":String]) : Void

Parameters

headerName

A string that represents an HTTP request header name.

headerValue A string that represents the value associated with headerName.

Returns

Nothing.

Description

Method; adds or changes HTTP request headers (such as Content-Type or SOAPAction) sent

with

POST actions. In the first usage, you pass two strings to the method: headerName and

headerValue. In the second usage, you pass an array of strings, alternating header names and

header values.

If multiple calls are made to set the same header name, each successive value replaces the value set

in the previous call.

You cannot add or change the following standard HTTP headers using this method:

Accept-Ranges, Age, Allow, Allowed, Connection, Content-Length, Content-Location,

Content-Range, ETag, Host, Last-Modified, Locations, Max-Forwards,

Proxy-Authenticate, Proxy-Authorization, Public, Range, Retry-After, Server, TE,

Trailer, Transfer-Encoding, Upgrade, URI, Vary, Via, Warning, and WWW-Authenticate.

Example

The following example adds a custom HTTP header named SOAPAction with a value of Foo to

an XML object named

my_xml:

my_xml.addRequestHeader("SOAPAction", "'Foo'");

The following example creates an array named headers that contains two alternating HTTP

headers and their associated values. The array is passed as a parameter to the

addRequestHeader() method.

var headers:Array = new Array("Content-Type", "text/plain",

"X-ClientAppVersion", "2.0");

my_xml.addRequestHeader(headers);