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

1509 lines
39 KiB
HTML
Raw Permalink Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>Retrieve Writer Information (QSPRWTRI) 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. -->
<!-- Print SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited by Kersten Oct 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>Retrieve Writer Information (QSPRWTRI) API</h2>
<div class="box" style="width: 65%;">
<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%">Receiver variable</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of receiver variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Printer name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</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;Optional Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="left" valign="top" width="50%">Writer name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(10)</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 Retrieve Writer
Information (QSPRWTRI) API retrieves writer information associated with the
specified printer or writer. The information retrieved is similar to what can
be seen when running the Work with Writer (WRKWTR) command for a particular
writer.</p>
<p>Additionally, this API can retrieve information about pending changes to a
particular writer. The fields that could contain possible pending changes
are:</p>
<ul>
<li>Next file separators</li>
<li>Next form type</li>
<li>Next message option</li>
<li>Next output queue library name</li>
<li>Next output queue name</li>
<li>Next separator drawer</li>
</ul>
<p>Changes to these fields result when the Change Writer (CHGWTR) command has
been used. The value specified in the Changes take effect field determines when
the pending changes take place.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Output Queue Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The receiver variable that receives the information requested. You can
specify the size of the area to be smaller than the format requested as long as
you specify the length parameter correctly. As a result, the API returns only
the data the area can hold.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable. If the length is larger than the size
of the receiver variable, the results are not predictable. The minimum length
is 8 bytes.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the writer information to be returned.</p>
<p>The following format name can be used:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td valign="top"><em><a href="#HDRWTR1">WTRI0100</a></em></td>
<td valign="top">Writer information</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Printer name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the printer for which writer information is to be returned. The
following special value is supported for this parameter:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*WRITER</em></td>
<td align="left" valign="top">Use the writer name specified on the writer name
parameter to return writer information.</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>Optional Parameter</h3>
<dl>
<dt><strong>Writer name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the writer for which writer information is to be returned. The
value of this parameter must be set to blanks if the printer name parameter is
not set to *WRITER.</p>
</dd>
</dl>
<br>
<h3><a name="HDRWTR1">WTRI0100 Format</a></h3>
<p>The following information is returned for the WTRI0100 format. See <a href=
"#HDRPRTZ100">Field Descriptions</a> for more information.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Started by user</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Writing status</td>
</tr>
<tr>
<td align="center" valign="top">19</td>
<td align="center" valign="top">13</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Waiting for message status</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Held status</td>
</tr>
<tr>
<td align="center" valign="top">21</td>
<td align="center" valign="top">15</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">End pending status</td>
</tr>
<tr>
<td align="center" valign="top">22</td>
<td align="center" valign="top">16</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Hold pending status</td>
</tr>
<tr>
<td align="center" valign="top">23</td>
<td align="center" valign="top">17</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Between files status</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Between copies status</td>
</tr>
<tr>
<td align="center" valign="top">25</td>
<td align="center" valign="top">19</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Waiting for data status</td>
</tr>
<tr>
<td align="center" valign="top">26</td>
<td align="center" valign="top">1A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Waiting for device status</td>
</tr>
<tr>
<td align="center" valign="top">27</td>
<td align="center" valign="top">1B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">On job queue status</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Type of writer</td>
</tr>
<tr>
<td align="center" valign="top">29</td>
<td align="center" valign="top">1D</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Writer job name</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Writer job user name</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Writer job number</td>
</tr>
<tr>
<td align="center" valign="top">58</td>
<td align="center" valign="top">3A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Printer device type</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="center" valign="top">44</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of separators</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Drawer for separators</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Align forms</td>
</tr>
<tr>
<td align="center" valign="top">86</td>
<td align="center" valign="top">56</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Output queue name</td>
</tr>
<tr>
<td align="center" valign="top">96</td>
<td align="center" valign="top">60</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Output queue library name</td>
</tr>
<tr>
<td align="center" valign="top">106</td>
<td align="center" valign="top">6A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Output queue status</td>
</tr>
<tr>
<td align="center" valign="top">107</td>
<td align="center" valign="top">6B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">108</td>
<td align="center" valign="top">6C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Form type</td>
</tr>
<tr>
<td align="center" valign="top">118</td>
<td align="center" valign="top">76</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message option</td>
</tr>
<tr>
<td align="center" valign="top">128</td>
<td align="center" valign="top">80</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Automatically end writer</td>
</tr>
<tr>
<td align="center" valign="top">138</td>
<td align="center" valign="top">8A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Allow direct printing</td>
</tr>
<tr>
<td align="center" valign="top">148</td>
<td align="center" valign="top">94</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message queue name</td>
</tr>
<tr>
<td align="center" valign="top">158</td>
<td align="center" valign="top">9E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message queue library name</td>
</tr>
<tr>
<td align="center" valign="top">168</td>
<td align="center" valign="top">A8</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">170</td>
<td align="center" valign="top">AA</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Changes take effect</td>
</tr>
<tr>
<td align="center" valign="top">180</td>
<td align="center" valign="top">B4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Next output queue name</td>
</tr>
<tr>
<td align="center" valign="top">190</td>
<td align="center" valign="top">BE</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Next output queue library name</td>
</tr>
<tr>
<td align="center" valign="top">200</td>
<td align="center" valign="top">C8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Next form type</td>
</tr>
<tr>
<td align="center" valign="top">210</td>
<td align="center" valign="top">D2</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Next message option</td>
</tr>
<tr>
<td align="center" valign="top">220</td>
<td align="center" valign="top">DC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Next file separators</td>
</tr>
<tr>
<td align="center" valign="top">224</td>
<td align="center" valign="top">E0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Next separator drawer</td>
</tr>
<tr>
<td align="center" valign="top">228</td>
<td align="center" valign="top">E4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Spooled file name</td>
</tr>
<tr>
<td align="center" valign="top">238</td>
<td align="center" valign="top">EE</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job name</td>
</tr>
<tr>
<td align="center" valign="top">248</td>
<td align="center" valign="top">F8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User name</td>
</tr>
<tr>
<td align="center" valign="top">258</td>
<td align="center" valign="top">102</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Job number</td>
</tr>
<tr>
<td align="center" valign="top">264</td>
<td align="center" valign="top">108</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Spooled file number</td>
</tr>
<tr>
<td align="center" valign="top">268</td>
<td align="center" valign="top">10C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Page being written</td>
</tr>
<tr>
<td align="center" valign="top">272</td>
<td align="center" valign="top">110</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Total pages</td>
</tr>
<tr>
<td align="center" valign="top">276</td>
<td align="center" valign="top">114</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Copies left to produce</td>
</tr>
<tr>
<td align="center" valign="top">280</td>
<td align="center" valign="top">118</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Total copies</td>
</tr>
<tr>
<td align="center" valign="top">284</td>
<td align="center" valign="top">11C</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Message key</td>
</tr>
<tr>
<td align="center" valign="top">288</td>
<td align="center" valign="top">120</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Initialize printer</td>
</tr>
<tr>
<td align="center" valign="top">289</td>
<td align="center" valign="top">121</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Printer device name</td>
</tr>
<tr>
<td align="center" valign="top">
299</td>
<td align="center" valign="top">12B</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Job system name</td>
</tr>
<tr>
<td align="center" valign="top">307</td>
<td align="center" valign="top">133</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Spooled file create date</td>
</tr>
<tr>
<td align="center" valign="top">314</td>
<td align="center" valign="top">13A</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Spooled file create time</td>
</tr>
</table>
<br>
<h3><a name="HDRPRTZ100">Field Descriptions</a></h3>
<p><strong>Align forms.</strong> The time at which the forms alignment message
will be sent.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*WTR</em></td>
<td align="left" valign="top">The writer determines when the message is
sent.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FILE</em></td>
<td align="left" valign="top">Control of the page alignment is specified by
each file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FIRST</em></td>
<td align="left" valign="top">The forms alignment message is only issued for
the first spooled file printed.</td>
</tr>
</table>
<br>
<p><strong>Allow direct printing.</strong> Whether the printer writer allows
the printer to be allocated to a job that prints directly to a printer. This
field is set to blanks for remote writers.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">Direct printing is not allowed</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">Direct printing is allowed.</td>
</tr>
</table>
<br>
<p><strong>Automatically end writer.</strong> When to end the writer if it is
to end automatically.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NORDYF</em></td>
<td align="left" valign="top">When no files are ready to print on the output
queue from which the writer is selecting files to be printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FILEEND</em></td>
<td align="left" valign="top">When the current spooled file has been
printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">The writer will not end, but it will wait for
more spooled files.</td>
</tr>
</table>
<br>
<p><strong>Between copies status.</strong> Whether the writer is between copies
of a multiple copy spooled file. This field is set to blanks for remote
writers. The possible values are Y (yes) or N (no).</p>
<p><strong>Between files status.</strong> Whether the writer is between spooled
files. The possible values are Y (yes) or N (no).</p>
<p><strong>Bytes available.</strong> Total format data length.</p>
<p><strong>Bytes returned.</strong> The length of the data returned.</p>
<p><strong>Changes take effect.</strong> The time at which the pending changes
to the writer take effect.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NORDYF</em></td>
<td align="left" valign="top">When all the current eligible files are
printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FILEEND</em></td>
<td align="left" valign="top">When the current spooled file is done
printing.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No pending changes to the writer.</td>
</tr>
</table>
<br>
<p><strong>Copies left to produce.</strong> The number of copies left to be
printed. This field is set to 0 when no file is printing.</p>
<p><strong>Drawer for separators.</strong> Identifies the drawer from which the
job and file separator pages are to be taken.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top" nowrap><em>-1</em></td>
<td align="left" valign="top">*FILE: The separator page prints from the same
drawer that the file is printed from. If you specify a drawer different from
the file that contains colored or different type paper, the page separator is
more identifiable.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>-2</em></td>
<td align="left" valign="top">*DEVD: The separator pages will print from the
separator drawer specified in the printer device description.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The first drawer.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The second drawer.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The third drawer.</td>
</tr>
</table>
<br>
<p><strong>End pending status.</strong> Whether an End Writer (ENDWTR) command
has been issued for this writer.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">No ENDWTR command was issued.</td>
</tr>
<tr>
<td align="left" valign="top"><em>I</em></td>
<td align="left" valign="top">*IMMED: The writer ends as soon as its output
buffers are empty.</td>
</tr>
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">*CNTRLD: The writer ends after the current copy
of the spooled file has been printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>P</em></td>
<td align="left" valign="top">*PAGEEND: The writer ends at the end of the
page.</td>
</tr>
</table>
<br>
<p><strong>Form type.</strong> The type of form being used to print the spooled
file.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The writer is started with the option to print
all spooled files of any form type.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FORMS</em></td>
<td align="left" valign="top">The writer is started with the option to print
all the spooled files with the same form type before using a different form
type.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*STD</em></td>
<td align="left" valign="top">The writer is started with the option to print
all the spooled files with a form type of *STD.</td>
</tr>
<tr>
<td align="left" valign="top"><em>form type name</em></td>
<td align="left" valign="top">The writer is started with the option to print
all the spooled files with the form type you specified.</td>
</tr>
</table>
<br>
<p><strong>Held status.</strong> Whether the writer is held. The possible
values are Y (yes) or N (no).</p>
<p><strong>Hold pending status.</strong> Whether a Hold Writer (HLDWTR) command
has been issued for this writer.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">No HLDWTR command was issued.</td>
</tr>
<tr>
<td align="left" valign="top"><em>I</em></td>
<td align="left" valign="top">*IMMED: The writer is held as soon as its output
buffers are empty.</td>
</tr>
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">*CNTRLD: The writer is held after the current
copy of the file has been printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>P</em></td>
<td align="left" valign="top">*PAGEEND: The writer is held at the end of the
page.</td>
</tr>
</table>
<br>
<p><strong>Initialize printer.</strong> How often to initialize the printer
device. This field is set to blanks for remote writers.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The writer initializes the printer device when
necessary.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The writer initializes the printer device only
before the first spooled file is printed and after device error recovery.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The writer initializes the printer device before
every spooled file is printed.</td>
</tr>
</table>
<br>
<p><strong>Job name.</strong> The name of the job that owns the spooled file
currently being processed by the writer. This field is blank when no spooled
file is printing.</p>
<p><strong>Job number.</strong> The number of the job that owns the spooled
file currently being processed by the writer. This field is blank when no
spooled file is printing.</p>
<p><strong>Job system
name.</strong> The name of the system where the job that created the spooled
file, currently being processed by the writer, ran. This field is blank when no
spooled file is printing. </p>
<p><strong>Message key.</strong> A key to the message that the writer is
waiting for. This field is blank when the writer is not waiting for a reply to
an inquiry message.</p>
<p><strong>Message option.</strong> Message option for sending a message to the
message queue when this form is finished.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*MSG</em></td>
<td align="left" valign="top">A message is sent to the message queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NOMSG</em></td>
<td align="left" valign="top">No message is sent to the message queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INFOMSG</em></td>
<td align="left" valign="top">An informational message is sent to the message
queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INQMSG</em></td>
<td align="left" valign="top">An inquiry message is sent to the message
queue.</td>
</tr>
</table>
<br>
<p><strong>Message queue library name.</strong> The name of the library that
contains the message queue.</p>
<p><strong>Message queue name.</strong> The name of the message queue that this
writer uses for operational messages.</p>
<p><strong>Next file separators.</strong> The next number of separator pages to
be printed when the change to the writer takes place.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>-1</em></td>
<td align="left" valign="top">*FILE: The number of separator pages is specified
by each file.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>-10</em></td>
<td align="left" valign="top">No pending change to the writer.</td>
</tr>
<tr>
<td align="left" valign="top"><em>number of separators</em></td>
<td align="left" valign="top">The number of separator pages to be printed.</td>
</tr>
</table>
<br>
<p><strong>Next form type.</strong> The name of the next form type to be
printed.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The writer is changed with the option to print
all spooled files of any form type.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FORMS</em></td>
<td align="left" valign="top">The writer is changed with the option to print
all the spooled files with the same form type before using a different form
type.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*STD</em></td>
<td align="left" valign="top">The writer is changed with the option to print
all the spooled files with a form type of *STD.</td>
</tr>
<tr>
<td align="left" valign="top"><em>form type name</em></td>
<td align="left" valign="top">The writer is changed with the option to print
all the spooled files with the form type name you specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No change has been made to this writer.</td>
</tr>
</table>
<br>
<p><strong>Next message option.</strong> The message option for sending a
message to the message queue when the next form type is finished.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*MSG</em></td>
<td align="left" valign="top">A message is sent to the message queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NOMSG</em></td>
<td align="left" valign="top">No message is sent to the message queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INFOMSG</em></td>
<td align="left" valign="top">An informational message is sent to the message
queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INQMSG</em></td>
<td align="left" valign="top">An inquiry message is sent to the message
queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No change pending.</td>
</tr>
</table>
<br>
<p><strong>Next output queue library name.</strong> The name of the library
that contains the next output queue. This field is blank if no changes have
been made to the writer.</p>
<p><strong>Next output queue name.</strong> The name of the next output queue
to be processed. This field is blank if no changes have been made to the
writer.</p>
<p><strong>Next separator drawer.</strong> This value indicates the drawer from
which to take the separator pages if there is a change to the writer.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top" nowrap><em>-1</em></td>
<td align="left" valign="top">*FILE: Separator pages print from the same drawer
that the spooled file prints from. If you specify a drawer different from the
spooled file that contains colored or different type paper, the page separator
is more identifiable.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>-2</em></td>
<td align="left" valign="top">*DEVD: Separator pages print from the separator
drawer specified in the printer device description.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>-10</em></td>
<td align="left" valign="top">No pending change to the writer.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The first drawer.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The second drawer.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The third drawer.</td>
</tr>
</table>
<br>
<p><strong>Number of separators.</strong> The number of separator pages to be
printed.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>-1</em></td>
<td align="left" valign="top">*FILE: The number of separator pages is specified
by each file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Number of separators</em></td>
<td align="left" valign="top">The number of separator pages to be printed.</td>
</tr>
</table>
<br>
<p><strong>On job queue status.</strong> Whether the writer is on a job queue
and, therefore, is not currently running. The possible values are Y (yes) or N
(no).</p>
<p><strong>Output queue library name.</strong> The name of the library that
contains the output queue from which spooled files are selected for
printing.</p>
<p><strong>Output queue name.</strong> The name of the output queue from which
spooled files are being selected for printing.</p>
<p><strong>Output queue status.</strong> The status of the output queue from
which spooled files are being selected for printing.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>H</em></td>
<td align="left" valign="top">The output queue is held.</td>
</tr>
<tr>
<td align="left" valign="top"><em>R</em></td>
<td align="left" valign="top">The output queue is released.</td>
</tr>
</table>
<br>
<p><strong>Page being written.</strong> The page number in the spooled file
that is currently being processed by the writer. The page number shown may be
lower or higher than the actual page number being printed because of buffering
done by the system. This field is set to 0 when no spooled file is
printing.</p>
<p><strong>Printer device name.</strong> The name of the printer device for
which writer information is being returned. This field is set to blanks for
remote writers.</p>
<p><strong>Printer device type.</strong> The type of the printer being used to
print the spooled file. This field is set to blanks for remote writers.</p>
<p>Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SCS</em></td>
<td align="left" valign="top">SNA (Systems Network Architecture) character
stream</td>
</tr>
<tr>
<td align="left" valign="top"><em>*IPDS</em></td>
<td align="left" valign="top">Intelligent Printer Data Stream</td>
</tr>
</table>
<br>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Spooled file create
date.</strong> The date the spooled file was created on the system. The date is
in the CYYMMDD format as follows:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">Century, where 0 indicates years 19<em>xx</em>
and 1 indicates years 20<em>xx</em>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>YY</em></td>
<td align="left" valign="top">Year</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Month</td>
</tr>
<tr>
<td align="left" valign="top"><em>DD</em></td>
<td align="left" valign="top">Day</td>
</tr>
</table>
<br>
<p>This field is blank when no spooled file is printing.</p>
<p><strong>Spooled file create time</strong> The time the spooled file was
created on the system. The time is in the HHMMSS format where:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>HH</em></td>
<td align="left" valign="top">Hour</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Minutes</td>
</tr>
<tr>
<td align="left" valign="top"><em>SS</em></td>
<td align="left" valign="top">Seconds</td>
</tr>
</table>
<p>This field is blank when no spooled file is printing.</p>
<p><strong>Spooled file name.</strong> The name of the spooled file currently
being processed by the writer. This field is blank when no spooled file is
printing.</p>
<p><strong>Spooled file number.</strong> The number of the spooled file
currently being processed by the writer. This field is set to 0 when no spooled
file is printing.</p>
<p><strong>Started by user.</strong> The name of the user that started the
writer.</p>
<p><strong>Total copies.</strong> The total number of copies to be printed.</p>
<p><strong>Total pages.</strong> The total number of pages in the spooled
file.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>number</em></td>
<td align="left" valign="top">The number of pages in the spooled file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No spooled file is printing.</td>
</tr>
</table>
<br>
<p><strong>Type of writer.</strong> The type of writer for which writer
information is being returned.</p>
<p>Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Printer writer</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Remote writer</td>
</tr>
</table>
<br>
<p><strong>User name.</strong> The name of the user who owns the spooled
file currently being processed by the writer. This field is blank when no file
is printing.</p>
<p><strong>Waiting for data status.</strong> Whether the writer has written all
the data currently in the spooled file and is waiting for more data.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">The writer is not waiting for more data.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Y</em></td>
<td align="left" valign="top">The writer has written all the data currently in
the spooled file and is waiting for more data. This condition occurs when the
writer is producing an open spooled file with SCHEDULE(*IMMED) specified.</td>
</tr>
</table>
<br>
<p><strong>Waiting for device status.</strong> Whether the writer is waiting to
get the device from a job that is printing directly to the printer. This field
is set to blanks for remote writers.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">The writer is not waiting for the device.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Y</em></td>
<td align="left" valign="top">The writer is waiting for the device</td>
</tr>
</table>
<br>
<p><strong>Waiting for message status.</strong> Whether the writer is waiting
for a reply to an inquiry message. The possible values are Y (yes) or N
(no).</p>
<p><strong>Writer job name.</strong> The job name of the printer writer.</p>
<p><strong>Writer job number.</strong> The job number of the printer
writer.</p>
<p><strong>Writer job user name.</strong> The name of the system user.</p>
<p><strong>Writing status.</strong> Whether the printer writer is in writing
status. The</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>Y</em></td>
<td align="left" valign="top">The writer is in writing status.</td>
</tr>
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">The writer is not in writing status.</td>
</tr>
<tr>
<td align="left" valign="top"><em>S</em></td>
<td align="left" valign="top">The writer is writing the file separators.</td>
</tr>
</table>
<br>
<h3>Error Messages</h3>
<table width="100%">
<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">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C19 E</td>
<td align="left" valign="top">Error occurred with receiver variable
specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C24 E</td>
<td align="left" valign="top">Length of the receiver variable is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF33C8 E</td>
<td align="left" valign="top">No writer information returned for printer
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3313 E</td>
<td align="left" valign="top">Writer &amp;1 not active nor on job queue.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3330 E</td>
<td align="left" valign="top">Necessary resource not available.</td>
</tr>
<tr>
<td align="left" valign="top">CPF33BB E</td>
<td align="left" valign="top">Writer name is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF33BC E</td>
<td align="left" valign="top">No writer information returned for writer
&amp;1.</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>
<hr>
API introduced: V2R3
<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=
"print1.htm">Print APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink