Shift Scroller left (QsnShfSclL) API

Required Parameter:

Session handle

Input

Binary(4)

Omissible Parameter Group:

2	Shift 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 Shift Scroller left (QsnShfSclL) API shifts the scroller to the left by the specified number of scroller columns. 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 left column and the first column 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

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.
CPFA340 E	Operation not supported with double-byte data.
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.
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 ]