swirl
Guide to OmniMark 8   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
  Related Syntax     Other Library Functions  
function  

HttpRequestSetSearchItem

 
 

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 Syntax
   HttpRequestSend
   HttpRequestSetFromUrl
   HttpRequestGetSearchItems
 
  Other Library Functions
   HttpConnectionSendResponse
   HttpLibraryVersion
   HttpObjectGetCookieAttributes
   HttpObjectGetCookieValues
   HttpObjectGetHeaders
   HttpObjectGetStatusReport
   HttpObjectIsInError
   HttpObjectSetCookieAttribute
   HttpObjectSetCookieValue
   HttpObjectSetHeader
   HttpRequest
   HttpRequestGetSearchItems
   HttpRequestSend
   HttpRequestSetFromUrl
   HttpRequestSetProxy
   HttpRequestSetSearchItem
   HttpResponse
   HttpResponseOutput
   HttpServiceAwaitRequest
 
 

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

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:27:39 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.