Change Low-Level Environment (QsnChgEnv) API

Required Parameter Group:

1	Low-level environment description	Input	Char(*)
2	Length of low-level environment description	Input	Binary(4)

Omissible Parameter Group:

3	Low-level environment handle	Input	Binary(4)
4	Error Code	I/O	Char(*)

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Change Low-Level Environment (QsnChgEnv) API changes the description for the given low-level environment. The Change Low-Level Environment exit routine will be called if specified on the user extension information of the Create Low-Level Environment (QsnCrtEnv) API.

Authorities and Locks

Display file authority: *USE
Display file library authority: *USE
Exit routine authority: *EXECUTE

Required Parameter Group

Low-level environment description: INPUT; CHAR(*)
The new environment description for the given environment. The format of this parameter is shown in Format of the Low-Level Environment Description.
Length of low-level environment description: INPUT; Binary(4)
The length of the low-level environment description parameter. The value specified must be 16, 36 or 38.

Omissible Parameter Group

Low-level environment handle: INPUT; BINARY(4)
The low-level environment to be modified. If this parameter is omitted or specified as 0, the default low-level environment is used.
Error code: I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error Code Parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.

Returned Value

Return code: OUTPUT; BINARY(4)
A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.

Error Messages

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C1D E	Length specified in parameter &1 not valid.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPFA318 E	Error calling exit routine.
CPFA31E E	Required parameter &1 omitted.
CPFA327 E	Low level environment description value incorrect.
CPFA334 E	Low level environment handle incorrect.
CPFA344 E	The file &2 in library &3 is not valid.

API introduced: V2R3

Top | Dynamic Screen Manager APIs | APIs by category