friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8826eae394
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/quiprtp.htm

280 lines
7.9 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Print Panel (QUIPRTP) API</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--Edited by Kersten Nov 2001 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Print Panel (QUIPRTP) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Application handle</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Print panel name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Eject option</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(1)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>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.</p>
<p>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.</p>
<br>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Application handle</strong></dt>
<dd>INPUT; CHAR(8)
<p> 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.</p>
</dd>
<dt><strong>Print panel name</strong></dt>
<dd>INPUT; CHAR(10)
<p> The name of the print head panel or print panel defined in the panel group
for the open application.</p>
</dd>
<dt><strong>Eject option</strong></dt>
<dd>INPUT; CHAR(1)
<p> 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.</p>
<p> One of the following values must be used:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>Y</em></td>
<td align="left" valign="top">The panel is printed at the top of a new
page.</td>
</tr>
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">The panel is not always printed at the top of a
new page.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p> The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF3C90 E</td>
<td width="85%" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A0B E</td>
<td align="left" valign="top">Application handle &amp;3 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A0C E</td>
<td align="left" valign="top">Application domain error for application
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A0F E</td>
<td align="left" valign="top">Previous error occurred while running application
&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A1F E</td>
<td align="left" valign="top">An active display already exists for this
application.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A11 E</td>
<td align="left" valign="top">Value is not correct. Reason code is &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A13 E</td>
<td align="left" valign="top">Application &amp;3 closed prematurely.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A14 E</td>
<td align="left" valign="top">Program defined by variable &amp;4 cannot be
called.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A15 E</td>
<td align="left" valign="top">Errors occurred in list exit program.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A18 E</td>
<td align="left" valign="top">Print heading must be specified first.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A19 E</td>
<td align="left" valign="top">Prologue is only allowed in first heading.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A23 E</td>
<td align="left" valign="top">Page length too small to print the list column
headings.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A24 E</td>
<td align="left" valign="top">Parameter &amp;1 not passed correctly.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A25 E</td>
<td align="left" valign="top">Return code length of &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A3B E</td>
<td align="left" valign="top">Application not open for print.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A3E E</td>
<td align="left" valign="top">Application not open for display.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A3F E</td>
<td align="left" valign="top">Panel &amp;4 was not found in panel group
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6A50 E</td>
<td align="left" valign="top">Error was found during display file or printer
file operation.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R2
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"uim1.htm">User Interface Manager (UIM) APIs</a> | <a href="aplist.htm">APIs by
category</a> </td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink