Write Line to Scroller (QsnWrtSclLin) API

The Write Line to Scroller (QsnWrtSclLin) API writes a line of data, such as an informational message, to the scroller. The data is written starting at the first position on the next scroller line. The active position after this operation is the start of the next scroller line following the row containing the last data character written, or specified by a control character sequence if one appears at the end of the data. If the entire line cannot fit in the scroller buffer, no portion of the data will be written.

Authorities and Locks

None

Required Parameter Group

Session handle

INPUT; BINARY(4)

A handle for the session to which the scroller line is to be written.

Line data

Input; CHAR(*)

The data to be written to the scroller. If the line 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.

Note: The first 2 bytes of the scroller are reserved for the prefix area to the left of the scroller line.

Line data length

Input; CHAR(*)

The length of the line data parameter.

Note: The first 2 bytes of the scroller are reserved for the prefix area to the left of the scroller line.

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