Print Panel (QUIPRTP) API
Required Parameter Group:
| 1 | Application handle | Input | Char(8) |
| 2 | Print panel name | Input | Char(10) |
| 3 | Eject option | Input | Char(1) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Print Panel (QUIPRTP) API prints a panel to the printer file for an opened print application. The values for all output fields used in the panel definition are taken from dialog variables in the variable pool. If the panel contains list areas, the values are also taken from list entries in the lists associated with the open application.
If the panel contains a list area that is incomplete at the bottom, the UIM automatically calls the program identified by the program dialog variable parameter of the Set List Attributes (QUISETLA) API to acquire more list entries. The program is called repeatedly until either the requested number of entries is added to the list or the list is marked complete at the bottom. For lists that are incomplete at the top, printing begins with the first entry in the list.
Authorities and Locks
None.
Required Parameter Group
- Application handle
- INPUT; CHAR(8)
The application handle assigned by the UIM and returned to the application program by the Open Display Application (QUIOPNDA) API or the Open Print Application (QUIOPNPA) API when the application is opened.
- Print panel name
- INPUT; CHAR(10)
The name of the print head panel or print panel defined in the panel group for the open application.
- Eject option
- INPUT; CHAR(1)
Determines whether or not this panel begins on a new page. An automatic page eject is done when a print head panel is printed after a print panel. However, even if Y is specified on the QUIPRTP API when the next print panel is printed, it does not cause a second page eject.
One of the following values must be used:
Y The panel is printed at the top of a new page. N The panel is not always printed at the top of a new page.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C90 E | Literal value cannot be changed. |
| CPF6A0B E | Application handle &3 not valid. |
| CPF6A0C E | Application domain error for application &1. |
| CPF6A0F E | Previous error occurred while running application &3. |
| CPF6A1F E | An active display already exists for this application. |
| CPF6A11 E | Value is not correct. Reason code is &3. |
| CPF6A13 E | Application &3 closed prematurely. |
| CPF6A14 E | Program defined by variable &4 cannot be called. |
| CPF6A15 E | Errors occurred in list exit program. |
| CPF6A18 E | Print heading must be specified first. |
| CPF6A19 E | Prologue is only allowed in first heading. |
| CPF6A23 E | Page length too small to print the list column headings. |
| CPF6A24 E | Parameter &1 not passed correctly. |
| CPF6A25 E | Return code length of &1 not valid. |
| CPF6A3B E | Application not open for print. |
| CPF6A3E E | Application not open for display. |
| CPF6A3F E | Panel &4 was not found in panel group &1. |
| CPF6A50 E | Error was found during display file or printer file operation. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V2R2
[ Back to top | User Interface Manager APIs | APIs by category ]