HttpObjectSetCookieAttribute - OmniMark function

function

HttpObjectSetCookieAttribute

Related Syntax

Other Library Functions

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

Declaration

  define function HttpObjectSetCookieAttribute
                 modifiable  stream HttpObject
     for         value       stream CookieName
     attribute   value       stream AttrName
     to          value       stream AttrValue

Purpose

This function sets a named attribute value for a cookie header in an HTTP request or response object. If a nonexistent cookie name is specified, the HTTP object will be in error. Usually, HttpObjectSetCookieAttribute is called in a server program.

Input arguments:

"HttpObject" -- an HTTP request or HTTP response object.
"CookieName" -- the name of the cookie. Note that any preceding "$" symbol should be omitted.
"AttrName" -- the name of the cookie attribute.
"AttrValue" -- the value to assign to the cookie attribute.

Example:

  ; HttpObjectSetCookieAttribute

  local HttpRequest my-Request
  local HttpResponse my-Response

  HttpObjectSetCookieAttribute my-Request
     for "DocUserID" attribute "Domain" to "www.omnimark.com"
  HttpObjectSetCookieAttribute my-Response
     for "DocUserID" attribute "Domain" to "www.omnimark.com"

[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]