HttpRequestGetSearchItems - OmniMark function

function

HttpRequestGetSearchItems

Related Syntax

Other Library Functions

Library: HTTP
Include: omtcp.xin, omhttp.xin

Declaration

  define function HttpRequestGetSearchItems
              read-only   stream   Request
     into     modifiable  stream   SearchItems

Purpose

This function returns the names and values of all search items defined for an HTTP request object as keyed items in a stream shelf. This function is usually used on the server side, to analyze the search items coming in from a request and to customize response information according to the search items specified in the request.

Input argument:

"Request" -- an HTTP request object.

Output argument:

"SearchItems" -- a returned shelf containing the search values as keyed items. The contents of the shelf are cleared before the search items are copied to it. The item key is the search item name.

Example:

  ; HttpRequestGetSearchItems

  local HttpRequest my-Request
  local stream all-Search variable

  HttpRequestGetSearchItems my-Request into all-Search

  output "No User!%n" when all-Search hasnt key "username"

[CONTENTS] [CONCEPTS] [SYNTAX] [LIBRARIES] [SAMPLES] [ERRORS] [INDEX]

Generated: April 21, 1999 at 2:01:08 pm
If you have any comments about this section of the documentation, send email to [email protected]