Shift Scroller Right (QsnShfSclR) API

The Shift Scroller Right (QsnShfSclR) API shifts the scroller to the right by the specified number of scroller columns. Any truncated data will become visible. If line wrap mode is on, shifting has no effect.

Restrictions

If the low-level environment description (see Format of the Low-Level Environment Description) for the session specifies DBCS support or the device supports CCSID-based I/O, the shift amount parameter is ignored and the default value is used.

Authorities and Locks

None.

Required Parameter

Session handle

INPUT; BINARY(4)

A handle for the session to be shifted.

Omissible Parameter Group

Shift amount

INPUT; BINARY(4)

The number of scroller columns to shift 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 Columns to Shift Scroller (QsnRtvSclNumShf) API. The scroller is shifted by the minimum of the shift amount and the number of scroller columns between the visible center column and the last column (determined by the longest line currently visible) in the scroller.

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