Print Scroller Data (QsnPrtScl) API

Required Parameter:

Session handle

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 Print Scroller Data (QsnPrtScl) API prints the entire contents of the scroller data to the default printer file. No printer output is produced if the scroller is empty. CCSID-based data in the scroller is converted to the job CCSID before being printed.

Restrictions

If the low-level environment description (see Format of the Low-Level Environment Description) for the session specifies DBCS support, or the device supports CCSID-based I/O, the printer file must have a record length greater than or equal to 4. A CPCA3D2 will be placed on the session message line otherwise. This can occur if the application uses the OVRPRTF (Override with Printer File) CL command.

Authorities and Locks

None.

Required Parameter

Session handle: INPUT; BINARY(4)
A handle for the session that the operation applies to.

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.
CPFA31E E	Required parameter &1 omitted.
CPFA343 E	Output operation not done.
CPFA3D3 E	Scroller not printed.
CPFA3D6 E	Session handle is incorrect.

API introduced: V2R3

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