HttpRequestSetSearchItem

function

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

Declaration

define function HttpRequestSetSearchItem
         modifiable  stream   Request
   for   value       string   SearchName
   to    value       string   SearchValue

Argument definitions

Request: is an HTTP request object (input argument).

SearchName: is the name of the search item (input argument).

SearchValue: is the value of the search item (input argument).

Purpose

Use HttpRequestSetSearchItem to set search item name-and-value pairs in an HTTP request object.

Requirements

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

  include "omhttp.xin"

Usage Notes

HttpRequestSetSearchItem is usually used together with HttpRequestGetSearchItems. It can appear in either a client or a server program, and is used to customize the information that will be returned from the server to the client.

Example:

  ; HttpRequestSetSearchItem
  include "omhttp.xin"
  
  process
     local HttpRequest my-Request
  
     HttpRequestSetSearchItem my-Request for "username" to "anonymous"

Related Topics

Other Library Functions