Write Line to Scroller with CCSID (QsnWrtSclLinCC) API

Required Parameter Group:

1	Session handle	Input	Binary(4)
2	Line data	Input	Char(*)
3	Line data length	Input	Binary(4)

Omissible Parameter:

4	CCSID	Input	Binary(4)
5	Error code	I/O	Char(*)

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Write Line to Scroller with CCSID (QsnWrtSclLinCC) 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.

Note: CDRA conversion is not performed upon this data.

Restrictions

This command is not supported by all control units. A CPFA306 error occurs if an attempt is made to issue this command to a control unit that does not support it.

The CCSID value given must be supported by the device or emulator, otherwise a CPF3BDE will be signaled.

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 in the CCSID given by the CCSID parameter 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

CCSID

INPUT; BINARY(4)

The CCSID of the data to be written. If the CCSID given is not supported by the device, a CPF3BDE is signaled.

If this parameter is omitted (zero is passed in as the CCSID), the job CCSID is used. If the job CCSID is 65535, the default job CCSID is used instead.

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.
CPF3BDE E	CCSID &1 not supported by API.
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.
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.

API Introduced: V5R3

Top | Dynamic Screen Manager APIs | APIs by category