Roll Scroller Down (QsnRollSclDown) API

The Roll Scroller Down (QsnRollSclDown) API rolls the scroller down 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 would cause the scroller to roll past its top, then the top of the scroller will be 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