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/qgyolspl.htm

2425 lines
71 KiB
HTML
Raw Permalink 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>Open List of Spooled Files (QGYOLSPL) 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 -->
<!--Changed by RJOHNSON 10/06/03 Fixed Starting splf Create date-->
<!--Changed by MINGO 11/13/03 Changed *PRINTING to *PRINTED-->
<!--Changed by VETTE 04/27/05 Changed Device to Print Device-->
<!--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>Open List of Spooled Files (QGYOLSPL) 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%">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">List information</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(80)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Number of records to return</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Sort information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Filter information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Qualified job name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(26)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Format of the generated list</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">9</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 Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">10</td>
<td align="left" valign="top" width="50%">Format of filter information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(8)</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 Open List of Spooled Files (QGYOLSPL) API generates a list of spooled
files on the system. It creates a list similar to the list created by calling
the List Spooled Files (QUSLSPL) API. The list can include all spooled files or
those of specific users, output queues, form types, user-specified data values,
statuses, printers, or specific jobs. The filtered list can then be sorted
depending on the value of the sort parameter. You can specify how many list
entries to return when calling this API. At a later time, you can request
additional entries from the list using the Get List Entries (QGYGTLE) API. You
can close this list by using the Close List (QGYCLST) API.</p>
<p><strong>Note:</strong> The QTEMP library and the system portion of the
library list could be different between the main job and the server job when
the list is being built asynchronously. If this is a problem, request that the
list be built synchronously.</p>
<p>For more information, see <a href="misc1b.htm">Process Open List
APIs</a>.</p>
<br>
<h3>Differences between QUSLSPL and QGYOLSPL</h3>
<ul>
<li>The QUSLSPL API puts the list of spooled files into a user space object
provided by the caller. The calling program can directly access the user space
storage. The QGYOLSPL API puts the list of spooled files into a temporary space
and assigns a handle for the list. The calling program cannot directly access
the storage where the list is placed. Instead, the calling program can retrieve
entries from the list by passing the assigned list handle to the Get List
Entries (QGYGTLE) API.</li>
<li>The QUSLSPL API does not return control to the calling program until the
list of spooled files is completely built in the user space object. The
QGYOLSPL API returns control as soon as the initial number of records requested
has been placed in the list. If the calling program requests zero records to be
returned initially, QGYOLSPL returns immediately after it verifies parameter
values, does some initial setup operations, and requests that the asynchronous
host server job builds the list.</li>
<li>The QGYOLSPL has a receiver variable parameter. The receiver variable
contains the initial number of records, if any, requested.</li>
<li>The QGYOLSPL has a list information parameter that contains the status
information about the list that was built or is being built.</li>
<li>The QUSLSPL API allows filtering on only one user profile name. The
QGYOLSPL API allows filtering on multiple user profile names.</li>
<li>The QUSLSPL API allows filtering on only one output queue name. The
QGYOLSPL API allows filtering on multiple output queue names.</li>
<li>The QUSLSPL API does not allow filtering on spooled file status. The
QGYOLSPL API allows filtering on multiple spooled file statuses.</li>
<li>The QUSLSPL API does not allow filtering on printer name. The QGYOLSPL API
allows filtering on multiple printer names.</li>
<li>The QUSLSPL API returns the list of spooled files in only one order. The
QGYOLSPL API has a sort information parameter to allow sorting on one or more
of the fields in the list.</li>
</ul>
<br>
<h3>Performance Impacts</h3>
<p>Filtering on multiple values of user name, qualified output queue name, or
user-specified data takes more processing power and time.</p>
<p>Additionally, filtering on a status or a printer device name takes more processing
power and time.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Output Queue Authority</em></dt>
<dd>*USE</dd>
<dt><em>Output Queue Library Authority</em></dt>
<dd>*EXECUTE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The variable used to return the number of records requested (given in the
number of records to return parameter) of spooled file information. See
<a href="#HDRSPLLST">Format of Receiver Variable</a> for a description of the
layout of this parameter.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable.</p>
</dd>
<dt><strong>List information</strong></dt>
<dd>OUTPUT; CHAR(80)
<p>Information about the list created by this program. For a description of the
layout of this parameter, see <a href="../apiref/oli.htm">Format of open list
information</a>.</p>
</dd>
<dt><strong>Number of records to return</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of records in the list to put into the receiver variable after
filtering and sorting has been done.</p>
<p>If -1 is specified for this parameter the entire list is built
synchronously.</p>
<p>If 0 is specified for this parameter the entire list is built asynchronously
in a server job.</p>
<p>If a positive number of records to return is specified, at least that many
records will be built synchronously and the remainder will be built
asynchronously in a server job.</p>
</dd>
<dt><strong>Sort information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Information on what fields within the record of information to sort. See
<a href="#HDRLSPLSI">Format of Sort Information</a> for a description of the
layout of this parameter. Note that when sorting is requested, the entire list
has to be built and sorted before any records can be returned.</p>
</dd>
<dt><strong>Filter information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The information in this parameter is used for filtering the list of spooled
file information. For more details about filtering options, see
<a href="#filterformat">Format of Filter Information</a>.</p>
</dd>
<dt><strong>Qualified job name</strong></dt>
<dd>INPUT; CHAR(26)
<p>The qualified job name of the job whose files are to be included in the
list. This parameter can be blank. If blanks are specified, spooled files will
be listed for all jobs that match the criteria specified in the filter
information parameter.</p>
<p>The qualified job name has three parts:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>Job name</em></td>
<td align="left" valign="top">CHAR(10).</td>
</tr>
<tr>
<td align="left" valign="top"></td>
<td align="left" valign="top">A specific job name or the following special value:<br>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em><strong>*</strong></em></td>
<td align="left" valign="top">Current job. The rest of the job name parameter
must be blank.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>User name</em></td>
<td align="left" valign="top">CHAR(10).</td>
</tr>
<tr>
<td align="left" valign="top"></td>
<td align="left" valign="top">A specific user profile name or blanks when the job name is
*.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Job number</em></td>
<td align="left" valign="top">CHAR(6).</td>
</tr>
<tr>
<td align="left" valign="top"></td>
<td align="left" valign="top">A specific job number or blanks when the job name is *.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Format of the generated list</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the spooled file information being returned.</p>
<p>You must specify one of the following:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em><a href="#HDRLSPL100">OSPL0100</a></em></td>
<td align="left" valign="top">Contains the basic information about the spooled
file.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRLSPL200">OSPL0200</a></em></td>
<td align="left" valign="top">Contains all the information in format OSPL0100 plus
additional information about the spooled file.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRLSPL300">OSPL0300</a></em></td>
<td align="left" valign="top">Contains the basic information about the spooled file. This
format differs from format OSPL0100 in that it provides slightly different
information with less processing time.</td>
</tr>
</table>
<br>
<p>The OSPL0100 format returns information faster than the OSPL0200 format.</p>
<p>The OSPL0300 format returns information faster than the OSPL0100 format.</p>
</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
Group</h3>
<dl>
<dt><strong><a name="HDROSPFilterFormat">Format of filter
information</a></strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the filter information passed in the Filter information
parameter.</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em><a href="#HDROSPF1">OSPF0100</a></em></td>
<td align="left" valign="top">Defines the format of the filter information when
filtering on one or more of the following:<br>
<ul>
<li>User name</li>
<li>Output queue name and library</li>
<li>Form type</li>
<li>User data</li>
<li>Spooled file status</li>
<li>Printer Device</li>
</ul>
</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDROSPF2">OSPF0200</a></em></td>
<td align="left" valign="top">Defines the format of the filter information when filtering on
one or more of the following:<br>
<ul>
<li>User name</li>
<li>Output queue name and library</li>
<li>Spooled file status</li>
<li>Printer device</li>
<li>Form type</li>
<li>User data</li>
<li>Job system name</li>
<li>Starting spooled file creation date</li>
<li>Starting spooled file creation time</li>
<li>Ending spooled file creation date</li>
<li>Ending spooled file creation time</li>
</ul>
</td>
</tr>
</table>
</dd>
</dl>
<br>
<h3><a name="HDRSPLLST">Format of Receiver Variable</a></h3>
<p>The following tables describe the order and format of the data returned in
the receiver variable.</p>
<br>
<h4><a name="HDRLSPL100">OSPL0100 Format</a></h4>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="top" 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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Spooled file name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User name</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Job number</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</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">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Total pages</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Current page</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Copies left to print</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</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">62</td>
<td align="center" valign="top">3E</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">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User data</td>
</tr>
<tr>
<td align="center" valign="top">82</td>
<td align="center" valign="top">52</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Status</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Form type</td>
</tr>
<tr>
<td align="center" valign="top">102</td>
<td align="center" valign="top">66</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Priority</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Internal job identifier</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Internal spooled file identifier</td>
</tr>
<tr>
<td align="center" valign="top">136</td>
<td align="center" valign="top">88</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Device type</td>
</tr>
<tr>
<td align="center" valign="top">146</td>
<td align="center" valign="top">92</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">
148</td>
<td align="center" valign="top">94</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to OSPL0100 extension</td>
</tr>
<tr>
<td align="center" valign="top">152</td>
<td align="center" valign="top">98</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of OSPL0100 extension</td>
</tr>
<tr>
<td align="center" valign="top">156</td>
<td align="center" valign="top">9C</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h4>Format OSPL0100 extension</h4>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="top" 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%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Job system name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Date spooled file was opened</td>
</tr>
<tr>
<td align="center" valign="top">15</td>
<td align="center" valign="top">F</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Time spooled file was opened</td>
</tr>
<tr>
<td align="center" valign="top">21</td>
<td align="center" valign="top">15</td>
<td align="left" valign="top">CHAR(11)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRLSPL200">Format OSPL0200</a></h4>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="top" 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%"></td>
<td align="left" valign="top" width="60%">Everything in format OSPL0100</td>
</tr>
<tr>
<td align="center" valign="top">160</td>
<td align="center" valign="top">A0</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Date spooled file was opened</td>
</tr>
<tr>
<td align="center" valign="top">167</td>
<td align="center" valign="top">A7</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Time spooled file was opened</td>
</tr>
<tr>
<td align="center" valign="top">173</td>
<td align="center" valign="top">AD</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Printer assigned</td>
</tr>
<tr>
<td align="center" valign="top">174</td>
<td align="center" valign="top">AE</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Printer name</td>
</tr>
<tr>
<td align="center" valign="top">184</td>
<td align="center" valign="top">B8</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRLSPL300">Format OSPL0300</a></h4>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Job name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Job number</td>
</tr>
<tr>
<td align="center" valign="top">26</td>
<td align="center" valign="top">1A</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">36</td>
<td align="center" valign="top">24</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">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">File status</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Date spooled file was opened</td>
</tr>
<tr>
<td align="center" valign="top">51</td>
<td align="center" valign="top">33</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Time spooled file was opened</td>
</tr>
<tr>
<td align="center" valign="top">57</td>
<td align="center" valign="top">39</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Spooled file schedule</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">Job system name</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="center" valign="top">44</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User data</td>
</tr>
<tr>
<td align="center" valign="top">78</td>
<td align="center" valign="top">4E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Spooled file form type</td>
</tr>
<tr>
<td align="center" valign="top">88</td>
<td align="center" valign="top">58</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">98</td>
<td align="center" valign="top">62</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">108</td>
<td align="center" valign="top">6C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Auxiliary storage pool</td>
</tr>
<tr>
<td align="center" valign="top">112</td>
<td align="center" valign="top">70</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Size of spooled file</td>
</tr>
<tr>
<td align="center" valign="top">116</td>
<td align="center" valign="top">74</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Spooled file size multiplier</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Total pages</td>
</tr>
<tr>
<td align="center" valign="top">124</td>
<td align="center" valign="top">7C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Copies left to print</td>
</tr>
<tr>
<td align="center" valign="top">128</td>
<td align="center" valign="top">80</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Priority</td>
</tr>
<tr>
<td align="center" valign="top">129</td>
<td align="center" valign="top">81</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">132</td>
<td align="center" valign="top">84</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Internet print protocol job identifier
</td>
</tr>
</table>
<br>
<br>
<h3><a name="filterformat">Format of Filter Information</a></h3>
<h4><a name="HDROSPF1">Filter
Information Format OSPF0100</a></h4>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</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%">Number of user names</td>
</tr>
<tr>
<td colspan="2" rowspan="2">These fields are repeated for each user to filter
on. The offsets vary.</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of output queue names</td>
</tr>
<tr>
<td colspan="2" rowspan="2">These fields are repeated for each output queue to
filter on. The offsets vary.</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Output queue name</td>
</tr>
<tr>
<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">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Form type</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User-specified data</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of statuses</td>
</tr>
<tr>
<td colspan="2" rowspan="2">These fields are repeated for each status to filter
on. The offsets vary.</td>
<td>CHAR(10)</td>
<td>Spooled file status</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">Number of printer device names<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td colspan="2" rowspan="2">These fields are repeated for each printer device to filter
on. The offsets vary.</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">Printer device name<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h4> <a name="HDROSPF2">Filter
Information Format OSPF0200</a></h4>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</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%">Length of filter information</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">Offset to user name entries</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of user name entries</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of user name entry</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to output queue name entries</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of output queue name entries</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of output queue name entry</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to spooled file status entries</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of spooled file status entries</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of spooled file status entry</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to printer device name entries</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of printer device name entries</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of printer device name entry</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Form type</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="center" valign="top">3E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User-specified data</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">System name</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Starting spooled file create date</td>
</tr>
<tr>
<td align="center" valign="top">87</td>
<td align="center" valign="top">57</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Starting spooled file create time</td>
</tr>
<tr>
<td align="center" valign="top">93</td>
<td align="center" valign="top">5D</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Ending spooled file create date</td>
</tr>
<tr>
<td align="center" valign="top">100</td>
<td align="center" valign="top">64</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Ending spooled file create time</td>
</tr>
<tr>
<td align="center" valign="top">106</td>
<td align="center" valign="top">6A</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3>User Name Entry</h3>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">User name</td>
</tr>
</table>
<br>
<br>
<h3>Output Queue Name Entry</h3>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Output queue name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Output queue library name</td>
</tr>
</table>
<br>
<br>
<h3>Spooled File Status Entry</h3>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Spooled file status</td>
</tr>
</table>
<br>
<br>
<h3>Printer Device Name Entry</h3>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Printer device name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRLSPLSI">Format of Sort Information</a></h3>
<p>For more details about the fields in the following table, see <a href=
"#HDRABFD">Field Descriptions</a>.</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="left" valign="top" width="10%">0</td>
<td align="left" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of keys to sort on</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="5" colspan="2">Offsets vary. These
fields repeat for each sort key field.</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Sort key field starting position</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Sort key field length</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(2)</td>
<td align="left" valign="top">Sort key field data type</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Sort order</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<p><strong>Note:</strong> If the last 3 fields (sort key field data type, sort
order, and the reserved field) are not used, then they must be set to
hexadecimal zeros. This causes all the data to be treated as character data,
and it is sorted in ascending order.</p>
<br>
<h3><a name="HDRABFD">Field Descriptions</a></h3>
<p><strong>Auxiliary storage pool.</strong> The auxiliary storage pool in which
the spooled file resides.</p>
<p>Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">*SYSTEM. System auxiliary storage pool</td>
</tr>
<tr>
<td align="left" valign="top"><em>2-255</em></td>
<td align="left" valign="top">The number of the auxiliary storage
pool.</td>
</tr>
</table>
<p><strong>Copies left to print.</strong> The remaining number of copies to be
printed. This attribute applies to printer device type spooled files only.</p>
<p><strong>Current page.</strong> The page number or record number currently
being written. The page number may be lower or higher than the page number
actually being printed because of buffering done by the system. For example, if
the spooled file is routed to a diskette unit or the writer is currently
printing job separators or file separators for the spooled file, the page
number shown may be zero.</p>
<p><strong>Date spooled file was opened.</strong> The date that the file was
opened in the CYYMMDD format.</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>
<p><strong>Device type.</strong> The type of device for which the spooled file
is intended. The possible values are PRINTER or DISKETTE.</p>
<p><strong>Ending spooled file
create date.</strong> The date the spooled file was created on the system. If
the Starting spooled file create date field is set to *ALL, then this field
must be set to blanks. If a date has been specified for the Starting spooled
file create date field, then this field must be set to a valid date. The date
must be in the CYYMMDD format or one of the following special values:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LAST</em></td>
<td align="left" valign="top">All spooled files with a create date and time
equal to or later than the starting spooled file create date are to be
returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>date</em></td>
<td align="left" valign="top">All spooled files with a create date and time equal to or
later than the starting spooled file create date and time and less than or
equal to the ending spooled file create date and time are to be returned.</td>
</tr>
</table>
<p>The date format CYYMMDD is defined 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>
<p><strong>Ending spooled file create time.</strong> The time the spooled file
was created on the system. This field must be set to blanks when special value
*ALL is used for field Starting spooled file create date or when special value
*LAST is used for field Ending spooled file create date. This field must have a
value set if a date is specified for field Ending spooled file create date. The
time must be in the HHMMSS format.</p>
<p>The time format HHMMSS is defined as follows:</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><strong>File status.</strong> The status of the file. The following list of
values is used to describe the status of the file:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">RDY The file is available to be
written to an output device by a writer.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">OPN The file has not been processed completely
and is not ready to be selected by a writer.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">CLO The file has been processed completely by a
program, but SCHEDULE(*JOBEND) was specified. The job that produced the spooled
file has not finished.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">SAV The file has been written and then saved.
This file remains saved until it is released.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">WTR This file currently is being produced by the
writer on an output device.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">HLD The file has been held.</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">MSGW This file has a message that needs a reply
or needs an action to be taken.</td>
</tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">PND This file is pending (waiting) to be
printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>9</em></td>
<td align="left" valign="top">PRT The file has been sent to the printer
completely, but the print complete status has not been sent back.</td>
</tr>
<tr>
<td align="left" valign="top"><em>10</em></td>
<td align="left" valign="top">FIN This spooled file is no longer in the system.
These spooled files are included in the list of spooled files only if the
qualified job name is specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>11</em></td>
<td align="left" valign="top">SND This spooled file is being sent or has been
sent to a remote system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>12</em></td>
<td align="left" valign="top">DFR This spooled file has been deferred from
printing.</td>
</tr>
</table>
<p><strong>Form type.</strong> The type of forms that should be loaded on the
printer before this spooled file is printed or spooled files whose form type
matches this value are included in the list. This attribute applies to printer
device type spooled files only. This field can be used in conjunction with the
user, output queue and library, user-specified data, status, device fields and
qualified job name parameter to subset the list of all the spooled files.</p>
<p>The following special values can be used for the form type:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files are included in the list regardless
of the value for form type.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*STD</em></td>
<td align="left" valign="top">Only files that specify the standard form type are included in
the list.</td>
</tr>
</table>
<p><strong>Internal job identifier.</strong> The internal identifier for the
job. Only the i5/OS APIs use this identifier, not any other interface on the
system. The identifier is not valid following an initial program load (IPL). If
you attempt to use it after an IPL, an exception occurs.
This identifier is always valid when used with the internal spooled file identifier as input to i5/OS APIs. For spooled files which have been detached from their jobs or which are on independent disk pools, this value is not valid as input to some i5/OS APIs such as <a href="qusrjobi.htm">Retrieve Job Information</a> (QUSRJOBI) that take this value without the internal spooled file identifier.</p>
<p><strong>Internal spooled file identifier.</strong> The input value that
other programs use to improve the performance of locating the spooled file on
the system. Only the spooled file APIs use this identifier, not any other
interface on the system. The identifier is not valid following an initial
program load (IPL). If you attempt to use it after an IPL, an exception
occurs.</p>
<p><strong>Internet print protocol job identifier.</strong> The IPP job
identifier assigned by the system based on the output queue to which the file
was added or moved. This value ranges from 1 to 2147483647 and is not
guaranteed to be unique for a given output queue.</p>
<p><strong>Job name.</strong> The name of the job that owns the spooled
file.</p>
<p><strong>Job number.</strong> The number of the job that owns the spooled
file.</p>
<p><strong>Job system name.</strong> The name of the system where the job that
created the spooled file ran.</p>
<p><strong>Length of filter
information.</strong> The number of bytes of the fixed portion for the filter
information provided. If this value is greater than 106, the extra bytes must
be set to hexidecimal zeros.</p>
<p><strong>Length of output queue name entry.</strong> The size, in bytes, of
the output queue name entry. The minimum allowed size is 20. The value of this
field will be used by the API to find the next output queue name entry.</p>
<p><strong>Length of printer device name entry.</strong> The size, in bytes, of
the printer device name entry. The minimum allowed size is 10. The value of
this field will be used by the API to find the next printer device name
entry.</p>
<p><strong>Length of spooled file status entry.</strong> The size, in bytes, of
the spooled file status entry. The minimum allowed size is 10. The value of
this field will be used by the API to find the next spooled file status
entry.</p>
<p><strong>Length of user name entry.</strong> The size, in bytes, of the user
name entry. The minimum allowed size is 10. The value of this field will be
used by the API to find the next user name entry.</p>
<p><strong><img src="delta.gif" alt="Start of change">Number of printer device names.</strong> The number of printer device names
to filter on. The value specified must be greater than or equal to 1 for filter
format OSPF0100. The value specified must be greater than or equal to 0 for
filter format OSPF0200. With filter format OSPF0200, a value of 0 (*ALL)
indicates spooled files are included in the list regardless of the printer
device name.</p>
<p>Spooled files whose assigned printer device matches one of the printer device names
specified are included in the list. <img src="deltaend.gif" alt="End of change"></p>
<p><strong>Number of keys to sort on.</strong> The number of fields within the
record structure to sort on. If 0 is specified, the list is not sorted.</p>
<p><strong>Number of output
queue name entries.</strong> The number of output queues to filter on. The
value specified must be greater than or equal to 1.</p>
<p>Spooled files whose output queue matches one of the output queues specified
are included in the list. </p>
<p><strong>Number of output queue names.</strong> The number of output queues
to filter on. The value specified must be greater than or equal to 0. A value
of 0 indicates spooled files are included in the list regardless of the output
queue the spooled file resides on.</p>
<p>Spooled files whose output queue matches one of the output queues specified
are included in the list.</p>
<p><strong>Number of spooled
file status entries.</strong> The number of spooled file statuses to filter on.
The value specified must be greater than or equal to 0. A value of 0 indicates
spooled files are included in the list regardless of the status of the spooled
file.</p>
<p>Spooled files whose current status matches one of the statuses specified are
included in the list. </p>
<p><strong>Number of statuses.</strong> The number of spooled file statuses to
filter on. The value specified must be greater than or equal to 1.</p>
<p>Spooled files whose current status matches one of the statuses specified are
included in the list.</p>
<p><strong>Number of user name
entries.</strong> The number of user names to filter on. The value specified
must be greater than or equal to 0. A value of 0 indicates spooled files are
included in the list regardless of the user name.</p>
<p>Spooled files owned by one of the user profile names specified are
included in the list. </p>
<p><strong>Number of user names.</strong> The number of user names to filter
on. The value specified must be greater than or equal to 1.</p>
<p>Spooled files owned by one of the user profile names specified are
included in the list.</p>
<p><strong>Offset to output
queue name entries.</strong> The offset, in bytes, from the beginning of the
structure, to one or more output queue name entries.</p>
<p><strong>Offset to printer device name entries.</strong> The offset, in
bytes, from the beginning of the structure, to one or more printer device name
entries.</p>
<p><strong>Offset to spooled file status entries.</strong> The offset, in
bytes, from the beginning of the structure, to one or more spooled file status
entries.</p>
<p><strong>Offset to user name entries.</strong> The offset, in bytes, from the
beginning of the structure, to one or more user name entries. </p>
<p><strong>Output queue library name.</strong> The name of the library where
the output queue resides.</p>
<p>The following special values can be used for the output queue library name
when filtering:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The current library for the current job.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list of the current job.</td>
</tr>
</table>
<p><strong>Output queue library name.</strong> The library where the output
queue is located.</p>
<p><strong>Output queue name.</strong> The name of the output queue to filter
on or the name of the output queue in which the spooled file is located. At
least one output queue or special value must be specified. This field can be
used in conjunction with the user, form type, user-specified data, status,
device fields and qualified job name parameter to subset the list of all the
spooled files.</p>
<p>The following special value is used for the output queue name when
filtering:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">
Spooled files are included in the list regardless of the output queue. When
this value is specified, the output queue library name must be blanks.The field
Number of output queue names must be set to 1 when using filtering information
format OSPF0100. The field Number of output queue name entries must be set to 0
to signify *ALL when using filtering information format OSPF0200. </td>
</tr>
</table>
<br>
<p><strong>Printer assigned.</strong> Set to 1 when the spooled file is
assigned to a specific printer. In this case, the printer name field contains
the name of the assigned printer. Set to 2 when the spooled file is assigned to
multiple printers. In this case, the printer name is set to blanks. Set to 3
when the spooled file is not assigned to a printer. In this case, the printer
name is set to blanks. This attribute applies to printer device type spooled
files only.</p>
<p><strong><img src="delta.gif" alt="Start of change">Printer device
name.</strong> The name of the printer device to filter on. At least one
printer device name or special value must be specified. This field can be used
in conjunction with the user, output queue and library, form type,
user-specified data, status fields and the qualified job name parameter to
subset the list of all the spooled files. This field is not valid for format
OSPL0100 and will be ignored for format OSPL0300 unless the only filtering
requested is for a single printer device name.
<strong>NOTE:</strong> For filtering
information format OSPF0100, the first 10 characters contain
the printer device, and the next 2 characters are reserved.</p>
<p>The following special value can be used for the device name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files are included in the list regardless
of the device name. When this value is specified, the Number of printer device names
to filter on must be 1.</td>
</tr>
</table><img src="deltaend.gif" alt="End of change">
<p><strong>Printer name.</strong> The name of the printer the spooled file has
been assigned to print on. This attribute applies to printer device type
spooled files only.</p>
<p><strong>Priority.</strong> The priority of the spooled file. The priority
ranges from 1 (highest) to 9 (lowest).</p>
<p><strong>Reserved.</strong> Reserved field. Must be set to hexadecimal or
binary zero.</p>
<p><strong>Size of spooled file.</strong> The spooled file size. Multiply this
field by the spooled file size multiplier field to get the size of the spooled
file in number of bytes. The size of the spooled file is the data stream size
plus the spooled file's attributes, plus the "overhead" storage used to store
the spooled file's data stream.</p>
<p><strong>Sort key field data type.</strong> Data type of field to sort. Refer
to QLGSORT API for information on the list of data types available.</p>
<p><strong>Sort key field length.</strong> The length of the field to sort
on.</p>
<p><strong>Sort key field starting position.</strong> Within the record of
information, the starting position of the field to sort on.</p>
<p><strong>Sort order.</strong> Used to specify if the list should be sorted in
ascending or descending order according to the key.</p>
<p><strong>Spooled file form type.</strong> The type of form to load in the
printer to print this file.</p>
<p><strong>Spooled file name.</strong> The name of the spooled file in the list
entry.</p>
<p><strong>Spooled file number.</strong> The number of the spooled file in the
list entry.</p>
<p><strong>Spooled file schedule.</strong> The schedule of the spooled file.
Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The spooled file is schedule
immediate. A spooling writer can process the spooled file immediately.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The spooled file is schedule file end. A spooling
writer cannot process the spooled file until it has been closed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The spooled file is schedule job end. A spooling
writer cannot process the spooled file until the job of the spooled file has
ended.</td>
</tr>
</table>
<p><strong>Spooled file size multiplier.</strong> The number to multiply the
size of spooled file field to get the size of the spooled file in number of
bytes.</p>
<p><strong>Spooled file status.</strong> The spooled file status to filter
on.</p>
<p>Refer to the QUSLSPL API for possible values for the spooled file status. At
least one status or special value must be specified. This field can be used in
conjunction with the user, output queue and library, form type, user-specified
data, device fields and the qualified job name parameter to subset the list of
all the spooled files.</p>
<p><strong>NOTE:</strong> When
using filter format OSPF0100, the first 10 characters contain the status, and
the next 2 characters are reserved. </p>
<p>The following special values can be used for the spooled file status:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top">*ALL</td>
<td align="left" valign="top">
Spooled files are included in the list regardless of the current status. The
field Number of statuses must be set to 1, when using filter information format
OSPF0100. The field Number of spooled file status entries must be set to 0 to
signify *ALL when using filter information format OSPF0200. </td>
</tr>
<tr>
<td align="left" valign="top">*CLOSED</td>
<td align="left" valign="top">The file has been completely processed by a
program, but SCHEDULE(*JOBEND) was specified. The job that produced the spooled
file has not finished.</td>
</tr>
<tr>
<td align="left" valign="top">*DEFERRED</td>
<td align="left" valign="top">This spooled file has been deferred from
printing.</td>
</tr>
<tr>
<td align="left" valign="top">*SENDING</td>
<td align="left" valign="top">This spooled file is being sent or has been sent
to a remote system.</td>
</tr>
<tr>
<td align="left" valign="top">*FINISHED</td>
<td align="left" valign="top">This spooled file is no longer in the system.
These spooled files are included in the list of spooled files only if the
qualified job name is specified.</td>
</tr>
<tr>
<td align="left" valign="top">*HELD</td>
<td align="left" valign="top">The file has been held.</td>
</tr>
<tr>
<td align="left" valign="top">*MESSAGE</td>
<td align="left" valign="top">This file has a message that needs a reply or
needs an action to be taken.</td>
</tr>
<tr>
<td align="left" valign="top">*OPEN</td>
<td align="left" valign="top">The file has not been completely processed and is
not ready to be selected by a writer.</td>
</tr>
<tr>
<td align="left" valign="top">*PENDING</td>
<td align="left" valign="top">This file is pending (waiting) to be
printed.</td>
</tr>
<tr>
<td align="left" valign="top">*PRINTER</td>
<td align="left" valign="top">The file has been completely sent to the printer,
but the print complete status has not been sent back.</td>
</tr>
<tr>
<td align="left" valign="top">*READY</td>
<td align="left" valign="top">The file is available to be written to an output
device by a writer.</td>
</tr>
<tr>
<td align="left" valign="top">*SAVED</td>
<td align="left" valign="top">The file has been written and then saved. This
file remains saved until it is released.</td>
</tr>
<tr>
<td align="left" valign="top">*WRITING</td>
<td align="left" valign="top">This file is currently being produced by the
writer on an output device.</td>
</tr>
</table>
<p><strong>Starting spooled file
create date.</strong> The date the spooled file was created on the system. The
date must be in the CYYMMDD format or one of the following special values:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top">*ALL</td>
<td align="left" valign="top">The returned list is not to be filtered based on
spooled file create date and spooled file create time.</td>
</tr>
<tr>
<td align="left" valign="top">*FIRST</td>
<td align="left" valign="top">All spooled files starting with the earliest
create date and time and less than or equal to the ending spooled file create
date and time are to be returned.</td>
</tr>
<tr>
<td align="left" valign="top">date</td>
<td align="left" valign="top">All spooled files with a create date and time
equal to or later than the starting spooled file create date and time and less
than or equal to the ending spooled file create date and time are to be
returned.
<p>The date format CYYMMDD is defined as follows:</p>
<table cellpadding="5">
<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>
<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>
</table>
</td>
</tr>
</table>
<p><strong>Starting spooled file create time.</strong> The time the spooled
file was created on the system. This field must be set to blanks when special
value *ALL or *FIRST is used for field Starting spooled file create date. This
field must have a value set if a date is specified for field Starting spooled
file create date. The time must be in the HHMMSS format.</p>
<p>The time format HHMMSS is defined as follows:</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><strong>System name.</strong> The name of the system where the job that
created the spooled file ran. The following special values are supported for
this field:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The returned list is not to be filtered based on
job system name.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td align="left" valign="top">Only spooled files created on the current system are to be
returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>job-system-name</em></td>
<td align="left" valign="top">Only spooled files created on the system specified are to be
returned.</td>
</tr>
</table>
<p><strong>Time spooled file was opened.</strong> The time that the file was
opened in the HHMMSS format.</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">Minute</td>
</tr>
<tr>
<td align="left" valign="top"><em>SS</em></td>
<td align="left" valign="top">Second</td>
</tr>
</table>
<br>
<p><strong>Total pages.</strong> The total number of pages or number of records
for a particular spooled file.</p>
<p><strong>User data.</strong> The 10 characters of user-specified data that
describe the file.</p>
<p><strong>User name.</strong> The name of the user that owns the spooled
file or the name of the user to filter on. At least one user name or special
value must be specified. This field can be used in conjunction with the output
queue and library, form type, user-specified data, status, device fields and
qualified job name parameter to subset the list of all the spooled files.</p>
<p><strong>NOTE:</strong> When
using filtering information format OSPF0100, the first 10 characters contain
the user name, and the next 2 characters are reserved.</p>
<p>The following special values can be used for the user name to filter on:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">
Spooled files are included in the list regardless of the creating user profile.
The field Number of user names must be set to 1 when using filtering format
OSPF0100. The field Number of user name entries must be set to 0 to signify
*ALL when using filtering format OSPF0200.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td align="left" valign="top">Spooled files owned by the current user profile are included
in the list.</td>
</tr>
</table>
<br>
<p><strong>User-specified data.</strong> Only spooled files whose
user-specified data or file name match this value are included in the list.
This field can be used in conjunction with the user, output queue and library,
form type, status, device fields and qualified job name parameter to subset the
list of all the spooled files.</p>
<p>The special value supported is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files are included in the list regardless
of the value for user-specified data.</td>
</tr>
</table>
<br>
<h3>Error Messages</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter list.</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">CPF3342 E</td>
<td align="left" valign="top">Job &amp;5/&amp;4/&amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3343 E</td>
<td align="left" valign="top">Duplicate job names found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF335D E</td>
<td align="left" valign="top">Job system name is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF335E E</td>
<td align="left" valign="top">Starting spooled file create date is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF335F E</td>
<td align="left" valign="top">Starting spooled file create time is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF336C E</td>
<td align="left" valign="top">Starting spooled file create time is not blank.</td>
</tr>
<tr>
<td align="left" valign="top">CPF336D E</td>
<td align="left" valign="top">Ending spooled file create date is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF336E E</td>
<td align="left" valign="top">Ending spooled file create date is not blank.</td>
</tr>
<tr>
<td align="left" valign="top">CPF336F E</td>
<td align="left" valign="top">Ending spooled file create time is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF337A E</td>
<td align="left" valign="top">Ending spooled file create time is not blank. </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">CPF3C30 E</td>
<td align="left" valign="top">Library name &amp;1 is not valid for output queue *ALL.</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">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9807 E</td>
<td align="left" valign="top">One or more libraries in library list deleted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9808 E</td>
<td align="left" valign="top">Cannot allocate one or more libraries on library list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9830 E</td>
<td align="left" valign="top">Cannot assign library &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>
<tr>
<td align="left" valign="top">GUI0002 E</td>
<td align="left" valign="top">&amp;2 is not valid for length of receiver variable.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0009 E</td>
<td align="left" valign="top">&amp;1 is not valid for number of statuses.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0011 E</td>
<td align="left" valign="top">&amp;1 is not valid for number of user names.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0012 E</td>
<td align="left" valign="top">&amp;1 is not valid for number of output queue names.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0024 E</td>
<td align="left" valign="top">&amp;1 is not valid for number of keys to sort on.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0025 E</td>
<td align="left" valign="top">&amp;1 is not valid for sort key field starting position.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0026 E</td>
<td align="left" valign="top">&amp;1 is not valid for sort key field length.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0027 E</td>
<td align="left" valign="top">&amp;1 is not valid for number of records to return.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0042 E</td>
<td align="left" valign="top">&amp;1 is not valid for status.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0078 E</td>
<td align="left" valign="top">*ALL cannot be specified with another value.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0079 E</td>
<td align="left" valign="top">*ALL cannot be specified with another value.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0080 E</td>
<td align="left" valign="top">*ALL cannot be specified with another value.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0081 E</td>
<td align="left" valign="top">*ALL cannot be specified with another value.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0108 E</td>
<td align="left" valign="top">Filter information is not valid. Reason code &amp;1.</td>
</tr>
</table>
<tr><img src="delta.gif" alt="Start of change">
<td align="left" valign="top">GUI0121 E</td>
<td align="left" valign="top">Printer name cannot be specified when format OSPL0100 is requested.<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
<hr>
API introduced: V3R6
<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 View Git Blame Copy Permalink