Roll Scroller Up (QsnRollSclUp) API

Required Parameter:

Session handle

Input

Binary(4)

Omissible Parameter Group:

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

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Roll Scroller Up (QsnRollSclUp) API rolls the scroller up by the specified number of scroller rows. A scroller row is distinct from a scroller line in that a scroller line consists of multiple scroller rows if line wrapping is set on and the line exceeds the width of the scroller.

Authorities and Locks

None.

Required Parameter

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

Omissible Parameter Group

Roll amount: INPUT; BINARY(4)
The number of scroller rows to roll the scroller by. If this parameter is omitted or set to 0, the default value is used. The default value can be queried using the Retrieve Number of Rows to Roll Scroller (QsnRtvSclNumRoll) API. If the roll amount causes the scroller to roll past its bottom, then the bottom of the scroller is displayed.
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.
CPFA333 E	Parameter &1 not positive integer value.
CPFA31E E	Required parameter &1 omitted.
CPFA343 E	Output operation not done.
CPFA344 E	The file &2 in library &3 is not valid.
CPFA345 E	The invite active flag is not valid.
CPFA3D3 E	Scroller not printed.
CPFA3D6 E	Session handle is incorrect.
CPFA3D8 E	Scroller display is not valid.

API introduced: V2R3

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