Initialize Low-Level Environment Description (QsnInzEnvD) API

Required Parameter Group:

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

Omissible Parameter:

Error code

I/O

Char(*)

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Initialize Low-Level Environment Description (QsnInzEnvD) API initializes a low-level environment description with default values. Unless otherwise specified in the low-level environment description in Format of the Low-Level Environment Description, pointer fields are set to the null pointer, numeric fields to 0, character flag fields to 0, and other character fields to blanks. For example, the default value for the color support field is 3, so this field will be set to 3.

Authorities and Locks

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

Required Parameter Group

Low-level environment description: OUTPUT; CHAR(*)
The low-level environment description to be initialized.
Length of low-level environment description: INPUT; Binary(4)
The length of the low-level environment description parameter. This parameter must be specified as 16, 36 or 38.

Omissible Parameter

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.
CPFA31E E	Required parameter &1 omitted.
CPFA344 E	The file &2 in library &3 is not valid.

API introduced: V2R3

[ Back to top | Dynamic Screen Manager APIs | APIs by category ]