Retrieve Screen Dimensions (QsnRtvScrDim) API

Omissible Parameter Group:

1	Number of rows	Output	Binary(4)
2	Number of columns	Output	Binary(4)
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 Screen Dimensions (QsnRtvScrDim) API retrieves the current dimensions of the screen. You must specify either the number-of-rows or the number-of-columns parameter, or a CPFA31E message will be issued.

Authorities and Locks

None.

Omissible Parameter Group

Number of rows: OUTPUT; BINARY(4)
The current height of the screen. This information will be set based on the current display size.
Number of columns: OUTPUT; BINARY(4)
The current width of the screen. This information will be set based on the current display size.
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.

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.
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

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