Backspace on Scroller Line (QsnSclBS) API

Required Parameter:

Session handle

Input

Binary(4)

Omissible Parameter:

Error code

I/O

Char(*)

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Backspace on Scroller Line (QsnSclBS) API sets the active position to the previous position on the current scroller line. If the active position is at the start of the line, this operation has no effect.

Authorities and Locks

None

Required Parameter

Session handle: INPUT; BINARY(4)
A handle for the session that the operation applies to.

Omissible Parameter

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.
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.
CPFA3D6 E	Session handle is incorrect.

API introduced: V2R3

Top | Dynamic Screen Manager APIs | APIs by category