Get Environment Variable Value

GetEnvVar

The GetEnvVar procedure (or GetEV) retrieves the value associated with a CGI environment variable.

The GetEnvVar procedure can be used by a CGI program to retrieve a specific CGI environment variable value.

environment-data  GetEnvVar(
  szEnvVar          *  VALUE OPTIONS(*STRING) 
)

See also: PutEnvVar, GetCookie

Parameters

szEnvVar
[input SChar(*) value]  An environment variable name. There are both predefined environment variables and user-created environment variables. The predefined environment variables for the CGI environment include the following:
AUTH_TYPE
CONTENT_LENGTH
CONTENT_TYPE
DOCUMENT_ROOT
GATEWAY_INTERFACE
CGI_MODE
CGI_ASCII_CCSID
CGI_EBCDIC_CCSID
CGI_OUTPUT_MODE
HTTP_ACCEPT
HTTP_FROM
HTTP_REFERER
HTTP_USER_AGENT
PATH_INFO
PATH_TRANSLATED
QUERY_STRING
REMOTE_ADDR
REMOTE_HOST
REMOTE_IDENT
REMOTE_USER
REQUEST_METHOD
SCRIPT_NAME
SERVER_NAME
SERVER_PORT
SERVER_PROTOCOL
SERVER_SOFTWARE

Return Value

If the function succeeds, the return value is the value (data) associated with the environment variable.

If the function fails, nothing is returned.