Retrieve Number of Rows to Roll Scroller (QsnRtvSclNumRoll) API

Required Parameter:

Session handle

Input

Binary(4)

Omissible Parameter Group:

2	Roll amount	Output	Binary(4)
3	Error code	I/O	Char(*)

Returned Value:

Roll amount

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Retrieve Number of Rows to Roll Scroller (QsnRtvSclNumRoll) API returns the default number of rows to roll the scroller by for the Roll Scroller Up (QsnRollSclUp) and Roll Scroller Down (QsnRollSclDown) APIs. The default number of rows is specified on the session description. See Create a Session (QsnCrtSsn) API and Change Session (QsnChgSsn) API for details.

Authorities and Locks

None.

Required Parameter

Session handle: INPUT; BINARY(4)
A handle for the session to be queried.

Omissible Parameter Group

Roll amount: OUTPUT; BINARY(4)
The variable that contains the number of scroller rows to roll by when the QsnRtvSclNumRoll API has completed.
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

Roll amount: OUTPUT; BINARY(4)
This API returns the value for the roll amount parameter 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.
CPFA3D6 E	Session handle is incorrect.

API introduced: V2R3

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