@GetHTTPHeader (Formula Language)

In a Web application, returns the value of an HTTP header from the browser client request being processed by the server.

Note: This @function is new with Release 6.

Syntax

@GetHTTPHeader( requestHeader )

Parameters

requestHeaderField

Text. The name of a request-header field, for example, "From," "Host," or "User-Agent."

Return value

requestHeaderValue

Text. The value of the request-header field, or null if the field does not exist.

Usage

@GetHTTPHeader is useful in formulas that run in the context of a browser.

The Notes® client always returns null for this formula.

See http:/www.w3.org/Protocols for the specification of a request header.

See @SetHTTPHeader for setting a response header value.

Examples

These examples return header field content based on this standard HTTP request:
GET /yourdb.nsf/All?OpenView HTTP/1.0
User-Agent: Mozilla 4.0 (X; I; Linux-2.0.35i586)
Host: mylinuxbox.ibm.com
Accept: image/gif, image/jpeg, */*
  1. This computed field formula returns "Mozilla 4.0 (X; I; Linux-2.0.35i586."
    @GetHTTPHeader("User-Agent")
  2. This computed field formula returns "mylinuxbox.ibm.com."
    @GetHTTPHeader("Host")