Delete Environment Variable

DltEnvVar

The DltEnvVar procedure (or DltEV) deletes a single, job-level environment variable or deletes all environment variables from the current job.

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

bSucceeded   DltEnvVar(
  szEnvVar          *  VALUE OPTIONS(*STRING)
)

See also: PutEnvVar, GetEnvVar GetCookie

Parameters

szEnvVar
[input Char(*) string]  The environment variable name to delete. The name must match the letter case of an existing environment variable. .

Return Value

If the function succeeds, the return value is '1' (*ON) otherwise the return value is '0' (*OFF).

Example

.....C..n01..............OpCode(ex)Extended-factor2+++++++++++++++++++
     C                   CallP     DltEnvVar('CUSTNO')

This call to DltEnvVar deletes the CUSTNO environment variable from the environment.

Remarks

The alternative name for this procedure is DLTEV.