Put Environment Variable Value

PutEnvVar

The PutEnvVar procedure (or PutEV) changes the value associated with a job-level environment variable.

The PutEnvVar procedure can be used by a CGI program to retrieve a specific CGI environment variable value, or a job-level environment variable.

void  PutEnvVar(
  szEnvVar     *   VALUE OPTIONS(*STRING)
)

Parameters

szEnvVar

[input SChar(*) value]  An environment variable and its value. Environment variables must be specified as character data in the following form:

TIME=Jan 21 2003

Where TIME is the environment variable, and "Jan 21 2003" is the value assigned to that variable. A subsequent GetEnvVar('TIME') would return this string to the caller. Note the semicolon that is required at the end of the environment variable's data. This is required and tells the procedure where the data ends.

 

You can specify a new variable name or use one of the pre-defined CGI variable names. For a list of the CGI environment variables see the GetEnvVar procedure.

 

Return Value

If there is no return value. However, check the XT_ERROR data structure's XT_ERRRLen subfield. If XT_ERRRLen is greater than zero, an error occurred during the call to PutEnvVar.