Write Characters to Scroller (QsnWrtSclChr) API

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