| 1 | Session handle | Input | Binary(4) |
| 2 | Line data | Input | Char(*) |
| 3 | Line data length | Input | Binary(4) |
| 4 | Error code | I/O | Char(*) |
| Return code | Output | Binary(4) |
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.
None
A handle for the session to which the scroller line is to be written.
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.
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.
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.
A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.
| 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. |
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]