Retrieve Low-Level Environment Window Mode (QsnRtvEnvWinMod) API

Required Parameter Group:

1	Window mode description	Output	Char(*)
2	Length of window mode 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 Retrieve Low-Level Environment Window Mode (QsnRtvEnvWinMod) API queries the state of the window mode for the low-level interfaces.

Authorities and Locks

None.

Window mode description: OUTPUT; CHAR(*)
The field in which the window mode description should be stored. The format of the data returned in this field is described in Format of the Data Returned.
Length of window mode description: INPUT; BINARY(4)
The length of the window mode description parameter. If the length is larger than the size of the receiver variable, the results are not predictable. The minimum length is 8. The API returns as much information as it can fit in this length. If the available information is longer, it is truncated. If the available information is shorter, the unused output is unchanged; whatever is already stored in that space remains there. To determine how much information the API actually returns in response to this call, see the bytes returned field. To determine how much information the API could return if space were available, see the bytes available field.

Low-level environment handle: INPUT; BINARY(4)
The low-level environment that the operation applies to. If this parameter is omitted or given with a value of zero, 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.

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.

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Window mode. Whether window mode is enabled or disabled. The possible values are:

0	Window mode is disabled.
1	Window mode is enabled.

Window mode description. The format of the remaining data returned is shown in Format of the Window Mode Description.

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C1D E	Length specified in parameter &1 not valid.
CPF3C24 E	Length of the receiver variable is 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.
CPFA334 E	Low level environment handle incorrect.

API introduced: V2R3