Write Characters to Scroller (QsnWrtSclChr) API

Required Parameter Group:

1	Session handle	Input	Binary(4)
2	Data	Input	Char(*)
3	Data length	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 Write Characters to Scroller (QsnWrtSclChr) API writes one or more characters to the scroller starting at the active position. The active position following this operation is one position past the last character written or that specified by a control character sequence if it appears at the end of the data. If the entire data string cannot fit in the scroller buffer, no portion of the string will be written.

Authorities and Locks

None

Required Parameter Group

Session handle: INPUT; BINARY(4)
A handle for the session to which the scroller characters are to be written.
Data: Input; CHAR(*)
The characters to be written to the scroller. If the data does not fit within the width of the session window, it is wrapped across multiple lines or truncated, depending on the value of the wrap indication field on the session description.
Data length: Input; CHAR(*)
The length of the data parameter.

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.
CPFA333 E	Parameter &1 not positive integer value.
CPFA31E E	Required parameter &1 omitted.
CPFA342 E	No matching shift-in or shift-out character found.
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.
CPFA3D7 E	Data for scroller is too long.
CPG3264 D	DBCS character string does not have even length.

API introduced: V2R3

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