Top

Name

http_request_header — returns array of HTTP request header lines

Synopsis

any http_request_header ( in array any ,
  in field_name varchar ,
  in attr-name varchar ,
  in default_value varchar );
 

Description

This function provides access to the HTTP request header lines.

Return Types

If no input parameters are supplied then this function returns a copy of the lines vector of VSP pages. If array, field_name and mime_attribute is supplied then this function will attempt to extract the associated value, if is cannot be found then the default_value input will be returned. If attr-name is supplied then the mime attribute from the field_name will be returned.

Note that when field value is requested then it will be treated as a MIME field and only value will be returned if found. For example consider presence of following header line: "Content-Type: text/plain; charset=utf-8", then if 'Content-Type' is requested, only "text/plain" will be returned. Use http_request_header_full to obtain the full field value.

Examples

Example 24.176. Accessing the HTTP request headers

<p>Your request follows</p>
  <?vsp
    declare header any;
    declare ix, len integer;
    declare host varchar;
    header := http_request_header ();
    len := length (header);
    ix := 0;
    while (ix < len)
    {
      http (aref (header, ix));
		  ix := ix + 1;
    }
    host := http_request_header(lines, 'Host', null, '*** NO HOST IN REQUEST ***')
  ?>