Sets or clears the value of an environment variable.
Note: When calling this routine, ensure you are using the 1024 calling convention.
Setting the value of an environment variable with C$SetEnv updates the corresponding environment variable immediately in the
process space of the current run unit. Thus, when the RM/COBOL runtime system uses environment variables for such actions
as file access name resolution, the call to C$SetEnv will have an immediate effect on that run unit.
Syntax:
CALL "C$SetEnv" USING name, value [, return]
Parameters:
- name
- PIC X(n)
- value
- PIC X(n)
- return
- PIC 9(n) BINARY, where n can be a digit from 1 to 9
On Entry:
- name
- The name of the environment variable to set or clear.
- value
- The value to which the environment variable is set. A value of SPACES indicates that the environment variable should be deleted.
On Exit:
- return
- The result code returned from the call: zero for success and non-zero for failure.
Comments:
On UNIX, environment variable names are case-sensitive. On Windows, environment variable names are not case-sensitive.