swirl
Guide to OmniMark 9   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
    Other Library Functions  
function  

cgiGetEnv

 
 

Library: CGI programming support (OMCGI)
Include: omcgi.xin

Declaration

define function cgiGetEnv
  into write-only string env-shelf

Argument definitions

env-shelf
A string or stream shelf of variable size.


Purpose

The cgiGetEnv function retrieves the values of all CGI-related environment variables. The function places those values on a keyed string shelf of name/value pairs, where the key of the item is the name of the environment variable and the item's value is the value of that variable. Declare the shelf you want the variables placed on as variable. Note that the function always clears the shelf before placing values on it. For example:

     declare #process-input has unbuffered
     declare #process-output has binary-mode
     include "omcgi.xin"
  
     process
        local string env-vars variable
  
        cgiGetEnv into env-vars

The cgiGetEnv function retrieves the following list of CGI-related environment variables. Note that not all web servers will set all of these variable values in all situations. If the web server doesn't set the value of a variable, its value is a zero-length string.

      Other Library Functions
 
 

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

OmniMark 9.1.0 Documentation Generated: September 2, 2010 at 1:38:10 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2010.