Library: HTTP support (OMHTTP) Include: omhttp.xin

Declaration

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

Argument definitions

Request

is an HTTP request object (input argument).

SearchItems

is a returned shelf containing the search values as keyed items (output argument. The contents of the shelf are cleared before the search items are copied to it. Each item on the SearchItem shelf has the name of the search item as its key and contains the value of the named search item.

Use HttpRequestGetSearchItems to get the names and values of all search items defined for an HTTP request object as keyed items in a stream shelf.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "omhttp.xin"

Usage Notes

Each search item in the SearchItems shelf contains the name of the search item as the key and the value of the search item as the value.

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.

Example:

  ; HttpRequestGetSearchItems
  include "omhttp.xin"
  
  process
     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"

Related Syntax    HttpRequestSetFromUrl    HttpRequestSetSearchItem

Other Library Functions    HttpConnectionSendResponse    HttpLibraryVersion    HttpObjectGetCookieAttributes    HttpObjectGetCookieValues    HttpObjectGetHeaders    HttpObjectGetStatusReport    HttpObjectIsInError    HttpObjectSetCookieAttribute    HttpObjectSetCookieValue    HttpObjectSetHeader    HttpRequest    HttpRequestGetSearchItems    HttpRequestSend    HttpRequestSetFromUrl    HttpRequestSetProxy    HttpRequestSetSearchItem    HttpResponse    HttpResponseOutput    HttpServiceAwaitRequest

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]