2509 lines
83 KiB
HTML
2509 lines
83 KiB
HTML
<!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 Map Information (QPQOLPM) 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. -->
|
|
<!-- Created by Jack Klarfeld for V5R3-->
|
|
<!-- 0300508 JETAYLOR html cleanup -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File Edited -->
|
|
<!-- 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>Open List of PDF Map Information (QPQOLPM) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
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">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">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">Format of filter information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">Qualified Map object name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(20)</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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Open List of PDF Map Information (QPQOLPM) API lists entries from a PDF
|
|
Map object and places the list in a receiver variable.
|
|
The size of the receiver variable determines the amount of information returned.
|
|
You can access additional
|
|
records by using the Get List Entries (QGYGTLE) API. On successful completion
|
|
of the API, a handle is returned in the list information parameter. You may use
|
|
this handle on subsequent calls to the following APIs:</p>
|
|
|
|
<ul>
|
|
<li>Get List Entries (QGYGTLE)</li>
|
|
<li>Close List (QGYCLST)</li>
|
|
</ul>
|
|
|
|
<p>For more information, see <a href="misc1b.htm">Process Open List APIs</a>.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Library authority</em></dt>
|
|
|
|
<dd>*EXECUTE</dd>
|
|
|
|
<dt><em>PDF Map object authority</em></dt>
|
|
|
|
<dd>*USE</dd>
|
|
|
|
<dt><em>PDF Map object lock</em></dt>
|
|
|
|
<dd>*SHRRD</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 provided. This must be large enough to
|
|
hold at least one record.</p>
|
|
</dd>
|
|
|
|
<dt><strong>List information</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(80)
|
|
|
|
<p>Information about the list of objects that was opened. 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.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the information to be returned for the specified object. The
|
|
valid format names are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#HDRMAP100">PDFM0100</a></em></td>
|
|
<td align="left" valign="top">Contains abbreviated information about a single entry from
|
|
the specified Map object. The format is repeated for each entry in the
|
|
specified Map object. If an entry is segmented, there is just a single entry; there
|
|
is not an entry for each segment.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#HDRMAP200">PDFM0200</a></em></td>
|
|
<td align="left" valign="top">Contains all information about a single entry from
|
|
the specified Map object. The format is repeated for each entry in the
|
|
specified Map object. If an entry is segmented, there is an entry for each
|
|
segment.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
|
|
<dt><strong>Filter information</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The information in this parameter is used for filtering the list of Map
|
|
information. You must specify the filter format you are using with the
|
|
Format of filter information parameter..</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format of filter information</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the filter information that can be specified for retrieving entries
|
|
from a Map object. The valid format name is:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#HDRFLTR100">FLTR0100</a></em></td>
|
|
<td align="left" valign="top">Use this format to specify which entries should be listed.
|
|
You can have all entries, or a subset of the entries in a Map object listed.</td>
|
|
</tr>
|
|
</table>
|
|
</dd>
|
|
|
|
<dt><strong>Qualified Map object name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The Map object for which you would like to retrieve information. The
|
|
qualified object name has two parts. The first 10 characters contain the object
|
|
name.</p>
|
|
|
|
<p>The second 10 characters contain the name of the library in which the object
|
|
is located.</p>
|
|
|
|
<p>The following special values are allowed:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
|
<td align="left" valign="top">The job's current library is used to locate the
|
|
object. If no library is specified as the current library for the job, the QGPL
|
|
library is used.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">The library list is used to locate the object.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
|
|
<p>The actual library that is used is returned with the object information.</p>
|
|
|
|
<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>
|
|
|
|
<h3><a name="HDRMAP100">PDFM0100 Format</a></h3>
|
|
|
|
<p>The following table shows the information returned for the PDFM0100 format.
|
|
If necessary, text fields are padded with blanks (X'40').
|
|
For more details about the fields in the this table, see <a href=
|
|
"#M0100FIELDD">PDFM0100 Format 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">0</td>
|
|
<td align="center" valign="top">0</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Sequence number of entry</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">4</td>
|
|
<td align="center" valign="top" width="10%">4</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Output queue name for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="center" valign="top">E</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Output queue library name for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Spooled file name for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">34</td>
|
|
<td align="center" valign="top">22</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Job name for input spooled file</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User name for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User data for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Form type for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">74</td>
|
|
<td align="center" valign="top">4A</td>
|
|
<td align="left" valign="top">CHAR(250)</td>
|
|
<td align="left" valign="top">Mail tag for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">324</td>
|
|
<td align="center" valign="top">144</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Segmented entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">325</td>
|
|
<td align="center" valign="top">145</td>
|
|
<td align="left" valign="top">CHAR(50)</td>
|
|
<td align="left" valign="top">Text description</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">375</td>
|
|
<td align="center" valign="top">177</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><a name="M0100FIELDD">PDFM0100 Format Field Descriptions</a></h3>
|
|
|
|
<p><strong>Form type for input spooled file.</strong> The type of forms that should
|
|
be loaded on the printer before this spooled file is printed. This is the value for
|
|
the input spooled file.</p>
|
|
|
|
<p>The following special values can be used for the form type for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for form type for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Job name for input spooled file.</strong> The name of the job that produced
|
|
the input spooled file. </p>
|
|
|
|
<p>The following special values can be used for the job name for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for job name for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Mail tag for input spooled file.</strong> The value of the mail tag
|
|
for the input spooled file.</p>
|
|
|
|
<p>The following special values can be used for mail tag for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless of the value
|
|
for mail tag for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Output queue library name for input spooled file.</strong> The name of the library
|
|
where the output queue for the input spooled file resides.</p>
|
|
|
|
<p>If Output queue name for input spooled file has a value of *ALL, than this field is
|
|
set to blanks.</p>
|
|
|
|
<p><strong>Output queue name for input spooled file.</strong> The name of the output queue
|
|
where the input spooled file resides.</p>
|
|
|
|
<p>The following special values can be used for the output queue name for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for output queue name for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> Set to a null value.</p>
|
|
|
|
<p><strong>Segmented entry.</strong> Indicates whether an entry is a segment.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The entry is a segment.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The entry is not a segment.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Sequence number of entry.</strong> The user-defined sequence number for an entry
|
|
in a PDF Map object.</p>
|
|
|
|
<p><strong>Spooled file name for input spooled file.</strong> The name of the existing
|
|
spooled file.</p>
|
|
|
|
<p>The following special values can be used for the spooled file name for input spooled
|
|
file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for spooled file name for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Text description.</strong> A brief description of the PDF Map entry.</p>
|
|
|
|
<p><strong>User data for input spooled file.</strong> The user-specified data which describe
|
|
the input spooled file.</p>
|
|
|
|
<p>The following special values can be used for the user data for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for user data for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>User name for input spooled file.</strong> The name of the user that
|
|
created the spooled file.</p>
|
|
|
|
<p>The following special values can be used for the user name for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for user name for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><a name="HDRMAP200">PDFM0200 Format</a></h3>
|
|
|
|
<p>The following table shows the information returned for the PDFM0200 format.
|
|
If necessary, text fields are padded with blanks (X'40').
|
|
For more details about the fields in the this table, see <a href=
|
|
"#M0200FIELDD">PDFM0200 Format 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%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Length of PDF Map entry</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">Sequence number of entry</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">Offset to mail information entry</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 mail information 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 PDF stream file information</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">Length of PDF stream file information</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">Offset to PDF spooled file information</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">Length of PDF spooled file information</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">Offset to AFPDS spooled file information</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 AFPDS spooled file information</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 Error information</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">Length of Error information</td>
|
|
</tr>-->
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">40</td>
|
|
<td align="center" valign="top" width="10%">28</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Output queue name for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Output queue library name for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="center" valign="top">3C</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Spooled file name for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">70</td>
|
|
<td align="center" valign="top">46</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Job name for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User name for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">90</td>
|
|
<td align="center" valign="top">5A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User data for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Form type for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">110</td>
|
|
<td align="center" valign="top">6E</td>
|
|
<td align="left" valign="top">CHAR(250)</td>
|
|
<td align="left" valign="top">Mail tag for input spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">360</td>
|
|
<td align="center" valign="top">168</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Segmented entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">361</td>
|
|
<td align="center" valign="top">169</td>
|
|
<td align="left" valign="top">CHAR(50)</td>
|
|
<td align="left" valign="top">Text description</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top">411</td>
|
|
<td align="center" valign="top">19B</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><a name="M0200FIELDD">PDFM0200 Format Field Descriptions</a></h3>
|
|
|
|
<p><strong>Form type for input spooled file.</strong> The type of forms that should
|
|
be loaded on the printer before this spooled file is printed. This is the value for
|
|
the input spooled file.</p>
|
|
|
|
<p>The following special values can be used for the form type for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for form type for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Job name for input spooled file.</strong> The name of the job that produced
|
|
the input spooled file. </p>
|
|
|
|
<p>The following special values can be used for the job name for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for job name for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Length of AFPDS spooled file information.</strong> The size, in bytes, of an AFPDS
|
|
Spooled File Information entry. If there is an entry (this field has a value greater than 0),
|
|
there is a maximum of one entry for each non-segmented entry,
|
|
and one entry for each segment of a segmented entry. For information on the format of an
|
|
AFPDS Spooled File Information entry, see
|
|
<a href= "#HDRAFPSPLFI">AFPDS Spooled File Information Entry</a>. </p>
|
|
|
|
<p><strong>Length of mail information entry.</strong> The size, in bytes, of a single Mail
|
|
information entry. If there is an entry (this field has a value greater than 0), there is a maximum of one entry for each non-segmented entry,
|
|
and one entry for each segment of a segmented entry.
|
|
For information on the format of a mail information entry, see
|
|
<a href= "#HDROMAIL">Mail information Entry</a>.</p>
|
|
|
|
<p><strong>Length of PDF Map entry.</strong>
|
|
The size, in bytes, of a single PDF Map entry for format PDFM0200.
|
|
The length includes, in addition to the PDFM0200 format, all entries required to provide the
|
|
data for one PDF Map entry. There is one PDF Map entry for each non-segmented entry, and one
|
|
PDF Map entry for each segment of a segmented
|
|
entry in the Map object. The entries are placed contiguously in storage.
|
|
For information on the format of a PDF Map entry, see <a href= "#HDRMAP200">PDFM0200</a>.
|
|
The number of PDF Map entries returned corresponds to the value in the Records returned field
|
|
in the Open list information format.</p>
|
|
|
|
<p><strong>Length of PDF spooled file information.</strong> The size, in bytes, of a PDF
|
|
Spooled File Information entry.
|
|
For information on the format of a PDF Spooled File Information Entry, see
|
|
<a href= "#HDRPDFSPLFI">PDF Spooled File Information Entry</a>.</p>
|
|
|
|
<p><strong>Length of PDF stream file information.</strong> The size, in bytes, of a PDF Stream
|
|
File Information Entry. This identifies the path where PSF/400 has written the PDF stream file.
|
|
If there is an entry (this field has a value greater than 0), there is a maximum of one entry for each non-segmented entry,
|
|
and one entry for each segment of a segmented entry.
|
|
For information on the format of a stream file entry, see
|
|
<a href= "#HDRPDFSTMF">PDF Stream File Information Entry</a>.</p>
|
|
|
|
<p><strong>Mail tag for input spooled file.</strong> The value of the mail tag
|
|
for the input spooled file.</p>
|
|
|
|
<p>The following special values can be used for mail tag for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless of the value
|
|
for mail tag for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Offset to AFPDS spooled file information.</strong> The offset, in bytes,
|
|
from the beginning of the PDFM0200 format structure, to an AFPDS Spooled File Information
|
|
entry. If this value is 0, an AFPDS Spooled File Information entry is not specified. </p>
|
|
|
|
<p><strong>Offset to mail information entry.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format, to a Mail information entry. If this value is 0,
|
|
a Mail information entry is not specified.</p>
|
|
|
|
<p><strong>Offset to PDF spooled file information.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format, to a PDF Spooled File Information entry. If this
|
|
value is 0, a PDF Spooled File information entry is not specified.</p>
|
|
|
|
<p><strong>Offset to PDF stream file information.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format, to a PDF Stream File Information entry. If this
|
|
value is 0, a PDF Stream File Information entry is not specified.</p>
|
|
|
|
<p><strong>Output queue library name for input spooled file.</strong> The name of the library
|
|
where the output queue for the input spooled file resides.</p>
|
|
|
|
<p>If Output queue name for input spooled file has a value of *ALL, than this field must
|
|
be set to blanks.</p>
|
|
|
|
<p><strong>Output queue name for input spooled file.</strong> The name of the output queue
|
|
where the input spooled file resides.</p>
|
|
|
|
<p>The following special values can be used for the output queue name for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for output queue name for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> Set to a null value.</p>
|
|
|
|
<p><strong>Segmented entry.</strong> Indicates whether an entry is a segment.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The entry is a segment.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The entry is not a segment.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<p><strong>Sequence number of entry.</strong> The user-defined sequence number for an entry
|
|
in a PDF Map object.</p>
|
|
|
|
<p><strong>Spooled file name for input spooled file.</strong> The name of the existing
|
|
spooled file.</p>
|
|
|
|
<p>The following special values can be used for the spooled file name for input spooled
|
|
file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for spooled file name for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Text description.</strong> A brief description of the PDF Map entry. </p>
|
|
|
|
<p><strong>User data for input spooled file.</strong>
|
|
The user-specified data which describe the input spooled file.</p>
|
|
|
|
<p>The following special values can be used for the user data for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for user data for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>User name for input spooled file.</strong> The name of the user that
|
|
created the spooled file.</p>
|
|
|
|
<p>The following special values can be used for the user name for input spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The entry is included in the list regardless
|
|
of the value for user name for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><a name="HDROMAIL">Mail Information Entry</a></h3>
|
|
|
|
<p>If necessary, text fields are padded with blanks (X'40').
|
|
For more details about the fields in the following table, see <a href=
|
|
"#MAILINFOFIELDD">Mail Information Entry 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%">Offset to message text</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">Length of message text</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">Offset to subject</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 subject</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">CCSID of message text and subject</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">Offset to ReplyTo e-mail address</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 ReplyTo e-mail address</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 TO e-mail address 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 TO e-mail address 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 TO e-mail address 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 CC e-mail address 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 CC e-mail address 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 CC e-mail address entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="center" valign="top">34</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to BCC e-mail address entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">56</td>
|
|
<td align="center" valign="top">38</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of BCC e-mail address entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="center" valign="top">3C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of BCC e-mail address entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to Body of e-mail entries</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 Body of e-mail entries</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">Length of Body of e-mail entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">76</td>
|
|
<td align="center" valign="top">4C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to attachment e-mail entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of attachment e-mail entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of attachment e-mail entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="center" valign="top">58</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to TO e-mail stream file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">92</td>
|
|
<td align="center" valign="top">5C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of TO e-mail stream file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">96</td>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to CC e-mail stream file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of CC e-mail stream file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">104</td>
|
|
<td align="center" valign="top">68</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to BCC e-mail stream file</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">Length of BCC e-mail stream file</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">Offset to PDF file for e-mail</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">Length of PDF file for e-mail</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">120</td>
|
|
<td align="center" valign="top">78</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Mail Sender</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">130</td>
|
|
<td align="center" valign="top">82</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User password</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">140</td>
|
|
<td align="center" valign="top">8C</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Master password</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">150</td>
|
|
<td align="center" valign="top">96</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Encryption level</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">151</td>
|
|
<td align="center" valign="top">97</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Print PDF file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">152</td>
|
|
<td align="center" valign="top">98</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Copy PDF file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">153</td>
|
|
<td align="center" valign="top">99</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Change PDF file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">154</td>
|
|
<td align="center" valign="top">9A</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Change Comments in PDF file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">155</td>
|
|
<td align="center" valign="top">9B</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Content Access to PDF file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">156</td>
|
|
<td align="center" valign="top">9C</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Document assembly</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">157</td>
|
|
<td align="center" valign="top">9D</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Use stream file for TO e-mail address entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">158</td>
|
|
<td align="center" valign="top">9E</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Use stream file for CC e-mail address entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">159</td>
|
|
<td align="center" valign="top">9F</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Use stream file for BCC e-mail address entries</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<h3><a name="MAILINFOFIELDD">Mail Information Entry Field Descriptions</a></h3>
|
|
|
|
<p><strong>CCSID of message text and subject.</strong> The CCSID associated with the
|
|
message text and subject.</p>
|
|
|
|
<p><strong>Change Comments in PDF file.</strong> Specifies whether users are
|
|
allowed to add or change comments (annotations) or form fields in the PDF file.
|
|
This field is applicable for Encryption levels *40RC4 and *128RC4.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F0'</em></td>
|
|
<td align="left" valign="top">The user is not allowed to change comments in the PDF file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F1'</em></td>
|
|
<td align="left" valign="top">The user is allowed to change comments in the PDF file.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
<p><strong>Change PDF file.</strong> Specifies whether users are allowed to change the PDF file.
|
|
This field is applicable for Encryption levels *40RC4 and *128RC4.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F0'</em></td>
|
|
<td align="left" valign="top">The user is not allowed to change the PDF file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F1'</em></td>
|
|
<td align="left" valign="top">The user is allowed to change the PDF file.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Content Access to PDF file.</strong> Specifies whether content accessibility for
|
|
the visually impaired is enabled for the PDF file.
|
|
This field is applicable only for an Encryption level of *128RC4.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F0'</em></td>
|
|
<td align="left" valign="top">Content accessibility for the visually impaired is disabled
|
|
in the PDF file. .</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F1'</em></td>
|
|
<td align="left" valign="top">content accessibility for the visually impaired is enabled
|
|
in the PDF file..</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Copy PDF file.</strong> Specifies whether users are allowed to copy or extract text
|
|
and graphics. This field is applicable for Encryption levels *40RC4 and *128RC4.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F0'</em></td>
|
|
<td align="left" valign="top">The user is not allowed to copy and extract text and graphics
|
|
in the PDF file. The accessibility interface is disabled.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F1'</em></td>
|
|
<td align="left" valign="top">The user is allowed to copy and extract text and graphics
|
|
in the PDF file. The accessibility interface is enabled.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Document assembly of PDF file.</strong> Specifies whether users are allowed to assemble the document
|
|
(insert, rotate, or delete pages and create bookmarks or thumbnail images).
|
|
This field is applicable for an Encryption level of *128RC4 only.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F0'</em></td>
|
|
<td align="left" valign="top">The user is not allowed to assemble the document</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F1'</em></td>
|
|
<td align="left" valign="top">The user is allowed to assemble the document</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
<p><strong>Encryption level.</strong> The encryption level for the PDF file.
|
|
If the encryption level is *40RC4 or *128RC4,
|
|
then the different encryption options valid for those levels of security will be returned.</p>
|
|
|
|
<p>The following special values are used for the encryption level:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F0'</em></td>
|
|
<td align="left" valign="top">The file is not encrypted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F1'</em></td>
|
|
<td align="left" valign="top">The PDF file is created with the 40-bit RC4 encryption level.
|
|
This level of encryption has a lower level of security that is compatible
|
|
with Adobe Acrobat Reader 3.X and later versions.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F2'</em></td>
|
|
<td align="left" valign="top"> The PDF file is created with the 128-bit RC4 encryption level.
|
|
This level of encryption is has a higher level of security but is only compatible with
|
|
Adobe Acrobat 5.X and later versions.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Length of attachment e-mail entry.</strong> The size, in bytes, of each entry used for
|
|
naming an e-mail attachment. Use one entry for each stream file. The entries must be concatenated,
|
|
as in an array. For information on the format of a stream file entry, see
|
|
<a href= "#HDRSTMF">Stream File Entry</a>.</p>
|
|
|
|
<p><strong>Length of BCC e-mail address entry.</strong> The size, in bytes, of each E-mail
|
|
Address entry used for the BCC of an e-mail.
|
|
For information on the format of an
|
|
e-mail addresses entry, see <a href= "#HDREMAIL">E-mail Address Entry</a>.</p>
|
|
|
|
<p>If Use stream file for BCC e-mail address entries is set to X'F1',
|
|
then this value will be 0.</p>
|
|
|
|
<p><strong>Length of BCC e-mail stream file.</strong> The size, in bytes, of the Stream
|
|
File entry containing the stream file which lists the BCCs used for an e-mail.
|
|
For information on the format of an
|
|
e-mail addresses entry, see <a href= "#HDRSTMF">Stream File Entry</a>.</p>
|
|
|
|
<p>If Use stream file for BCC e-mail address entries is set to X'F0', then this value will be 0.</p>
|
|
|
|
<p><strong>Length of Body of e-mail entry.</strong> The size, in bytes, of each entry used for
|
|
naming a stream file placed into the body of the e-mail. Use one entry for each stream file.
|
|
The entries must be concatenated, as in an array.
|
|
For information on the format of a stream file entry,
|
|
see <a href= "#HDRSTMF">Stream File Entry</a>.</p>
|
|
|
|
<p><strong>Length of CC e-mail address entry.</strong> The size, in bytes, of each E-mail
|
|
Address entry used for the CC of an e-mail. For information on the format of an
|
|
e-mail addresses entry, see <a href= "#HDREMAIL">E-mail Address Entry</a>.</p>
|
|
|
|
<p>If Use stream file for CC e-mail address entries is set to X'F1', then this value will be 0.</p>
|
|
|
|
<p><strong>Length of CC e-mail stream file.</strong> The size, in bytes, of the Stream
|
|
File entry containing the stream file which lists the CCs used for an e-mail. For information on the format of a stream file
|
|
entry, see <a href= "#HDRSTMF">Stream File Entry</a>.</p>
|
|
|
|
<p>If Use stream file for CC e-mail address entries is set to X'F0', then this value will be 0.</p>
|
|
|
|
<!--<p><strong>Length of Error information.</strong> The size, in bytes,-->
|
|
|
|
<p><strong>Length of message text.</strong> The size, in bytes, of the message text that gets
|
|
placed into the body of the e-mail.</p>
|
|
|
|
<p>The following special values can be used for the message text:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No message text will be included in the body of the e-mail.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If the length of the message text is 0, then
|
|
the default message text is obtained from message PQT4133 in
|
|
message file QPQMSGF.</p>
|
|
|
|
<p><strong>Length of PDF file for e-mail</strong> The size, in bytes, of a File Name
|
|
Entry. This identifies the name to be used for the PDF file produced from
|
|
a spooled file, that is attached to an e-mail.
|
|
For information on the format of a file name entry, see
|
|
<a href= "#HDRFILENAME">File Name Entry</a>.</p>
|
|
|
|
<p><strong>Length of ReplyTo to e-mail address.</strong> The size, in bytes, of an E-mail
|
|
Address entry used for the ReplyTo of an e-mail. For information on the format of an
|
|
e-mail addresses entry, see <a href= "#HDREMAIL">E-mail Address Entry</a>.</p>
|
|
|
|
<p>The following special values can be used for the ReplyTo e-mail address:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*MAILSENDER</em></td>
|
|
<td align="left" valign="top">Replies will be sent to the FROM e-mail address.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Length of subject.</strong> The size, in bytes, of the text that is used for the
|
|
subject of the e-mail.</p>
|
|
|
|
<p>The following special values can be used for the subject:</p>
|
|
|
|
<p><strong>Length of subject.</strong> The size, in bytes, of the text that is used for the
|
|
subject of the e-mail.</p>
|
|
|
|
<p>The following special values can be used for the subject:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No subject will be used in the body of the e-mail.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If the length of the subject is 0, then
|
|
the default subject is obtained from message PQT4133 in
|
|
message file QPQMSGF.</p>
|
|
|
|
<p><strong>Length of TO e-mail address entry.</strong> The size, in bytes, of each E-mail
|
|
Address entry used for the TO of an e-mail. For information on the format of an
|
|
e-mail addresses entry, see <a href= "#HDREMAIL">E-mail Address Entry</a>.</p>
|
|
|
|
<p>If Use stream file for TO e-mail address entries is set to X'F1', then this value will be 0.</p>
|
|
|
|
<p>The following special values can be used for the TO e-mail address entry:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SPLF</em></td>
|
|
<td align="left" valign="top">The e-mail address to be used is specified as an attribute of
|
|
the spooled file (USRDFNDTA('MAILTAG(e-mail-address)' parameter).</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Length of TO e-mail stream file.</strong> The size, in bytes, of the Stream
|
|
File entry containing the stream file which lists the TOs used for an e-mail.
|
|
If the stream file name is surrounded by quotes, use all characters within the quotes as
|
|
the stream file name.
|
|
For information on the format of an
|
|
e-mail addresses entry, see <a href= "#HDRSTMF">Stream File Entry</a>.</p>
|
|
|
|
<p>If Use stream file for TO e-mail address entries is set to X'F0', then this value will be 0.</p>
|
|
|
|
<p><strong>Master password.</strong> The master password associated with the PDF file to be
|
|
created. Either an encrypted value or a special value in clear text is returned. </p>
|
|
|
|
<p>This field is applicable for Encryption levels *40RC4 and *128RC4.</p>
|
|
|
|
<p>The following special value can be used for the master password:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No master password is specified for the PDF file.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Mail Sender.</strong> The user profile from whom the e-mail is being sent.</p>
|
|
|
|
<p>The following special values can be used for the mail sender:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*PSFCFG</em></td>
|
|
<td align="left" valign="top">The mail sender specified on the PSF configuration object
|
|
will be used for the mail sender.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Number of attachment e-mail entries.</strong> The number of stream files to be
|
|
attached to the e-mail. This value does not include the spooled file converted to PDF.</p>
|
|
|
|
<p><strong>Number of BCC e-mail address entries.</strong> The number of BCC e-mail addresses to
|
|
be used for sending an e-mail.</p>
|
|
|
|
<p>If Use stream file for BCC e-mail address entries is set to X'F1', then this value will be 0.</p>
|
|
|
|
<p><strong>Number of Body of e-mail entries.</strong> The number of stream files to be
|
|
placed into the body of the e-mail.</p>
|
|
|
|
<p><strong>Number of CC e-mail address entries.</strong> The number of CC e-mail addresses to
|
|
be used for sending an e-mail.</p>
|
|
|
|
<p>If Use stream file for CC e-mail address entries is set to X'F1', then this value will be 0.</p>
|
|
|
|
<p><strong>Number of TO e-mail address entries.</strong> The number of TO e-mail addresses to
|
|
be used for sending an e-mail.</p>
|
|
|
|
<p>If Use stream file for TO e-mail address entries is set to X'F1', then this value will be 0.</p>
|
|
|
|
<p>If Use stream file for TO e-mail address entries is set to X'F1', then this value will be 0.</p>
|
|
|
|
<p><strong>Offset to attachment e-mail entries.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format structure, to a list of attachment entries.
|
|
If this value is 0, a list of attachment entries is not specified.</p>
|
|
|
|
<p><strong>Offset to BCC e-mail address entries.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format structure, to a list of BCC e-mail address entries.
|
|
This area contains the BCC e-mail addresses to which the PDF file is sent.</p>
|
|
|
|
<p>If Use stream file for BCC e-mail address entries is set to X'F1', then this value will be 0.</p>
|
|
|
|
<p><strong>Offset to BCC e-mail stream file.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format structure, to a file name which contains a list of BCC e-mail
|
|
address entries.</p>
|
|
|
|
<p>If Use stream file for BCC e-mail address entries is set to X'F0', then this value will be 0.</p>
|
|
|
|
<p><strong>Offset to Body of e-mail entries.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format structure, to a list of Stream file entries.
|
|
If this value is 0, a list of Stream file entries is not specified.</p>
|
|
|
|
<p><strong>Offset to CC e-mail address entries.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format structure, to a list of CC e-mail address entries.
|
|
This area contains the CC e-mail addresses to which the PDF file is sent.</p>
|
|
|
|
<p>If Use stream file for CC e-mail address entries is set to X'F1', then this value will be 0.</p>
|
|
|
|
<p><strong>Offset to CC e-mail stream file.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format structure, to a file name which contains a list of CC
|
|
e-mail address entries.</p>
|
|
|
|
<p>If Use stream file for CC e-mail address entries is set to X'F0', then this value will be 0.</p>
|
|
|
|
<!--<p><strong>Offset to Error information.</strong> The offset, in bytes, from
|
|
the beginning of the structure, to -->
|
|
|
|
<p><strong>Offset to message text.</strong> The offset, in bytes, from the beginning of
|
|
the PDFM0200 format, to the message text which gets placed in to the body of the e-mail.
|
|
If this value is 0, message text is not specified.</p>
|
|
|
|
<p><strong>Offset to PDF file for e-mail</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format, to the PDF File For E-mail Entry.</p>
|
|
|
|
<p><strong>Offset to ReplyTo e-mail address.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format, to the E-mail ddress Entry for a ReplyTo e-mail address.
|
|
If this value is 0, a ReplyTo e-mail address is not specified.</p>
|
|
|
|
<p><strong>Offset to subject.</strong> The offset, in bytes, to the subject of the e-mail.
|
|
If this value is 0, a subject is not specified.</p>
|
|
|
|
<p><strong>Offset to TO e-mail address entries.</strong> The offset, in bytes, from
|
|
the beginning of the PDFM0200 format, to to a list of TO e-mail address entries.
|
|
This area contains the TO e-mail addresses to which the PDF file is sent.</p>
|
|
|
|
<p><strong>Offset to TO e-mail stream file.</strong> The offset, in bytes, from the beginning
|
|
of the PDFM0200 format, to a file name which contains a list of TO e-mail address entries.</p>
|
|
|
|
<p>If Use stream file for TO e-mail address entries is set to X'F0', then this value will be 0.</p>
|
|
|
|
<p><strong>Print PDF file.</strong> Specifies whether users are allow to print the PDF file.
|
|
This field is applicable for Encryption levels *40RC4 and *128RC4. An additional value is
|
|
available for an Encryption level of *128RC4.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F0'</em></td>
|
|
<td align="left" valign="top">The user is not allowed to print the PDF file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F1'</em></td>
|
|
<td align="left" valign="top">The user is allowed to print the PDF file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F2'</em></td>
|
|
<td align="left" valign="top">The user is only allowed to print at a low resolution (image).
|
|
This prevents the user from recreating the PDF file with different security settings. Printing
|
|
may be slower because each page will be printed as a bit-mapped image. This value can be
|
|
returned only for an Encryption level of *128RC4.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Use stream file for BCC e-mail address entries.</strong> Indicates if a stream file
|
|
containing BCC e-mail addresses is being used.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F0'</em></td>
|
|
<td align="left" valign="top">A stream file for BCC e-mail address entries is not being used.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F1'</em></td>
|
|
<td align="left" valign="top">A stream file for BCC e-mail address entries is being used.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Use stream file for CC e-mail address entries.</strong> Indicates if a stream file
|
|
containing CC e-mail addresses is being used.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F0'</em></td>
|
|
<td align="left" valign="top">A stream file for CC e-mail address entries is not being used.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F1'</em></td>
|
|
<td align="left" valign="top">A stream file for CC e-mail address entries is being used.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> Set to a null value.</p>
|
|
|
|
<p><strong>Use stream file for TO e-mail address entries.</strong> Indicates if a stream file
|
|
containing TO e-mail addresses is being used.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F0'</em></td>
|
|
<td align="left" valign="top">A stream file for TO e-mail address entries is not being used.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'F1'</em></td>
|
|
<td align="left" valign="top">A stream file for TO e-mail address entries is being used.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>User password.</strong> The user password associated with the PDF file to be
|
|
created. Either an encrypted value or a special value in clear text is returned.</p>
|
|
|
|
<p>This field is applicable for Encryption levels *40RC4 and *128RC4.</p>
|
|
|
|
<p>The following special value can be used for the user password:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No user password is specified for the PDF file.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3><a name="HDREMAIL">E-mail Address Entry</a></h3>
|
|
|
|
<p>This table is used for mapping the TO, CC, BCC and ReplyTo e-mail addresses.
|
|
If necessary, the field is padded with blanks (X'40').
|
|
For more details about the fields that can be used with the following table, see <a href=
|
|
"#EMAILFIELDD">E-mail Address Entry Field Description</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(80)</td>
|
|
<td align="left" valign="top" width="60%">E-mail address</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><a name="EMAILFIELDD">E-mail Address Entry Field Description</a></h3>
|
|
|
|
<p><strong>E-mail address. </strong>An e-mail address.</p>
|
|
|
|
<h3><a name="HDRSTMF">Stream File Entry</a></h3>
|
|
|
|
<p>This table is used for mapping the stream files that can be used for the Body, Attachment, TO,
|
|
CC, and BCC stream files. Use one entry for each stream file.
|
|
If you are specifying a stream file for the Body, the file extension (for example, txt or htm)
|
|
must be specified in lower case. Otherwise, the file will be sent as an attachment.
|
|
If necessary, the field is padded with blanks (X'40').
|
|
For more details about the field that can be used with the following table,
|
|
see <a href="#STMFFIELDD">Stream File Entry Field Description</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(255)</td>
|
|
<td align="left" valign="top" width="60%">Stream file name</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><a name="STMFFIELDD">Stream File Entry Field Description</a></h3>
|
|
|
|
<p><strong>Stream file name. </strong>A path-qualified stream file name.</p>
|
|
|
|
|
|
<h3><a name="HDRPDFSTMF">PDF Stream File Information Entry</a></h3>
|
|
<p>If necessary, the Public Authority field is padded with blanks (X'40').
|
|
For more details about the fields in the following table, see <a href=
|
|
"#PSFSTMFFIELDD">PDF Stream File Information Entry 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%">Offset to PDF file name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">4</td>
|
|
<td align="center" valign="top" width="10%">4</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Length of PDF file name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">8</td>
|
|
<td align="center" valign="top" width="10%">8</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Public Authority</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">18</td>
|
|
<td align="center" valign="top" width="10%">11</td>
|
|
<td align="left" valign="top" width="20%">CHAR(2)</td>
|
|
<td align="left" valign="top" width="60%">Reserved</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<h3><a name="PSFSTMFFIELDD">PDF Stream File Information Entry Field Descriptions</a></h3>
|
|
|
|
<p><strong>Length of PDF file name.</strong> The size, in bytes, of the Stream File entry
|
|
which contains the PDF file name. For information on the format of a Stream File entry, see
|
|
<a href= "#HDRSTMF">Stream File Entry</a>.</p>
|
|
|
|
<p><strong>Offset to PDF file name.</strong> The offset, in bytes, from the beginning of
|
|
the PDFM0200 format, to the Stream File entry for a PDF file. </p>
|
|
|
|
<p><strong>Public Authority.</strong> The public authority for the PDF stream file. The default
|
|
is *EXCLUDE.</p>
|
|
|
|
<p>The following special values may be specified:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*EXCLUDE</em></td>
|
|
<td align="left" valign="top">Users are excluded from accessing the object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*RWX</em></td>
|
|
<td align="left" valign="top">Users are given *RWX authority to perform all operations on
|
|
the object except those limited to the master or controlled by object existence, object
|
|
management, object alter, and object reference authority. Users can change the object and
|
|
perform basic functions on the object. *RWX authority provides object operational authority
|
|
and all the data authorities.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*RX</em></td>
|
|
<td align="left" valign="top">The users are given *RX authority to perform basic operations on
|
|
object, such as run a program or display the contents of a file.
|
|
The user is prevented from changing the object. *RX authority
|
|
provides object operational authority and read and execute
|
|
authorities.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*RW</em></td>
|
|
<td align="left" valign="top">The users are given *RW authority to view the contents of an object
|
|
and change the contents of an object. *RW authority provides object
|
|
operational authority and data read, add, update, and delete
|
|
authorities.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*WX</em></td>
|
|
<td align="left" valign="top">Users are given *WX authority to change the contents of an object
|
|
and run a program or search a library or directory. *WX authority provides object operational
|
|
authority and data add, update, delete, and execute authorities.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*R</em></td>
|
|
<td align="left" valign="top">Users are given *R authority to view the contents of an object.
|
|
*R authority provides object operational authority and data read authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*W</em></td>
|
|
<td align="left" valign="top">Users are given *W authority to change the contents of an object.
|
|
*W authority provides object operational authority and data add, update, and delete authorities.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*X</em></td>
|
|
<td align="left" valign="top">users are given *X authority to run a program or search a
|
|
library or directory. *X authority provides object operational authority and data execute
|
|
authority.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> Set to a null value.</p>
|
|
|
|
<h3><a name="HDRPDFSPLFI">PDF Spooled File Information Entry</a></h3>
|
|
|
|
<p>These fields are used for mapping the PDF spooled file information.
|
|
If necessary, text fields are padded with blanks (X'40').
|
|
For more details about the fields in the following table, see <a href=
|
|
"#SPLFFIELDD">PDF and AFPDS Spooled File Information Entry 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 for output spooled file</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 for output spooled file</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">Spooled file name for output spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="center" valign="top">1E</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User data for output spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Form type for output spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="left" valign="top">CHAR(255)</td>
|
|
<td align="left" valign="top">User defined data for output spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">305</td>
|
|
<td align="center" valign="top">13B</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<h3><a name="HDRAFPSPLFI">AFPDS Spooled File Information Entry</a></h3>
|
|
|
|
<p>These fields are used for mapping the AFPDS spooled file information.
|
|
If necessary, text fields are padded with blanks (X'40').
|
|
For more details about the fields in the following table, see <a href=
|
|
"#SPLFFIELDD">PDF and AFPDS Spooled File Information Entry 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 for output spooled file</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 for output spooled file</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">Spooled file name for output spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="center" valign="top">1E</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User data for output spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Form type for output spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="left" valign="top">CHAR(255)</td>
|
|
<td align="left" valign="top">User defined data for output spooled file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">305</td>
|
|
<td align="center" valign="top">13B</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<h3><a name="SPLFFIELDD">PDF and AFPDS Spooled File Information Entry Field Descriptions</a></h3>
|
|
|
|
<p><strong>Form type for output spooled file.</strong> The type of forms that should
|
|
be loaded on the printer before this spooled file is printed. This is the value which will be
|
|
used when a file is spooled.</p>
|
|
|
|
<p>The following special values can be used for the form type for output spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SPLF</em></td>
|
|
<td align="left" valign="top">The form type of the original spooled file will be used.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Output queue library name for output spooled file.</strong> The name of the library
|
|
where the output queue for the file which will be spooled resides.</p>
|
|
|
|
<p><strong>Output queue name for output spooled file.</strong> The name of the output queue
|
|
to which the file to be spooled will be written.</p>
|
|
|
|
<p>The following special values can be used for the form type for output queue name
|
|
for output spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*PSFCFG</em></td>
|
|
<td align="left" valign="top">The output queue specified in the PSF configuration object
|
|
will be used when writing the PDF file to spool.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> Set to a null value.</p>
|
|
|
|
<p><strong>Spooled file name for output spooled file.</strong> The name which will be used
|
|
for the file that gets spooled.</p>
|
|
|
|
<p>The following special values can be used for the spooled file name for output spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SPLF</em></td>
|
|
<td align="left" valign="top">The name of the original spooled file will be used.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>User data for output spooled file.</strong> The user-specified data which will
|
|
describe the file to be spooled.</p>
|
|
|
|
<p>The following special values can be used for the user data for output spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SPLF</em></td>
|
|
<td align="left" valign="top">The user data of the original spooled file will be used.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>User defined data for output spooled file.</strong> The user-defined data that will
|
|
be used for the file to be spooled.</p>
|
|
|
|
<p>The following special values can be used for the user defined data for output spooled file:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SPLF</em></td>
|
|
<td align="left" valign="top">The user defined data of the original spooled file will be used.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><a name="HDRFILENAME">File Name Entry</a></h3>
|
|
|
|
<p>This table is used for mapping a file name that is not path-qualifed.
|
|
Use this entry for mapping a PDF file for e-mail entry.
|
|
If necessary, the field is padded with blanks (X'40').
|
|
For more details about the field that can be used with the following table,
|
|
see <a href="#HDRFILENAMEDD">File Name Entry Field Description</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(80)</td>
|
|
<td align="left" valign="top" width="60%">File name</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><a name="HDRFILENAMEDD">File Name Entry Field Description</a></h3>
|
|
|
|
<p><strong>File name. </strong>A file name which does not contain path information.</p>
|
|
|
|
<h3><a name="HDRFLTR100">FLTR0100 format</a></h3>
|
|
|
|
<p>The following table shows the information provided for the FLTR0100 format.
|
|
If necessary, use blanks (X'40') as the pad character for text fields.
|
|
For more details about the fields in the following table, see <a href=
|
|
"#FILTERFIELDD">FLTR0100 format Field Descriptions</a>.</p>
|
|
<p>The minimum length that can be specified for this format, using field
|
|
Length of filter information, is 8. For any fields not included due to the length specification,
|
|
a value of *ALL will be used.</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" width="10%">4</td>
|
|
<td align="center" valign="top" width="10%">4</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Sequence number for filter</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">Output queue name for filter</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Output queue library name for filter</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Spooled file name for filter</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">38</td>
|
|
<td align="center" valign="top">26</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Job name for filter</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User name for filter</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">User data for filter</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">Form type for filter</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">78</td>
|
|
<td align="center" valign="top">4E</td>
|
|
<td align="left" valign="top">CHAR(250)</td>
|
|
<td align="left" valign="top">Mail tag for filter</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<h3><a name="FILTERFIELDD">FLTR0100 Format Field Descriptions</a></h3>
|
|
|
|
<p><strong>Form type for filter.</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 field can be used in conjunction with any of the other filter values to subset
|
|
the list of Map entries.</p>
|
|
|
|
<p>The following special values can be used for the form type for filter:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">Map entries are included in the list regardless
|
|
of the value for form type.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This field must be padded with blanks (X'40').</p>
|
|
|
|
<p><strong>Job name for filter.</strong> The name of the job that created the spooled file.
|
|
This field can be used in conjunction with any of the other filter values to subset
|
|
the list of Map entries.</p>
|
|
|
|
<p>The following special values can be used for the form type for filter:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">Map entries are included in the list regardless
|
|
of the value for job name.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Length of filter information.</strong> The size, in bytes, of the Filter
|
|
Information Format FLTR0100. The minimum length that can be specified is 8. For any fields not
|
|
included due to the length specification,a value of *ALL will be used.
|
|
</p><p>For information on the Filter Information Format, see
|
|
<a href= "#HDRFLTR100">Filter Information Format FLTR0100</a>.</p>
|
|
|
|
<p><strong>Mail tag for filter.</strong> The value of the mail tag that matches this value
|
|
are included in the list. </p>
|
|
<p>This field can be used in conjunction with any of the other filter values to subset
|
|
the list of Map entries.</p>
|
|
|
|
<p>Here is information on specifying a mail tag for filter:</p>
|
|
|
|
<ul>
|
|
<li>Embedded blanks will be used as part of the mail tag.</li>
|
|
<li>If necessary, the field must be padded with blanks (X'40').</li>
|
|
<li>Do not use single quotes around the text string, as they will be interpreted as part
|
|
of the text string.</li>
|
|
<li>Case is preserved. </li>
|
|
</ul>
|
|
|
|
<p>The following special values can be used for the mail tag:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">Map entries are included in the list regardless
|
|
of the value for mail tag.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Output queue library name for filter.</strong> The name of the library where
|
|
the output queue resides.</p>
|
|
|
|
<p>The following special value 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>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">
|
|
Map entries are included in the list regardless of the output queue library name. When
|
|
this value is specified, the output queue library name must not be blank and must not
|
|
have a value of *ALL.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Output queue name for filter.</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 any of the other filter values to subset
|
|
the list of Map entries.</p>
|
|
|
|
<p>The following special value is used for the output queue name when
|
|
filtering:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">
|
|
Map entries are included in the list regardless of the output queue name. When
|
|
this value is specified, the output queue library name must be blanks.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This field must be padded with blanks (X'40').</p>
|
|
|
|
<p><strong>Sequence number for filter.</strong> The user-defined sequence number on which
|
|
to filter.</p>
|
|
|
|
<p>The following values are used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00000000'</em></td>
|
|
<td align="left" valign="top">All entries will be searched. If a listed entry is
|
|
non-segmented, all of the entry's information for the specified format is provided.
|
|
If a listed entry is segmented, just the base portion of the entry is provided;
|
|
information on individual segments is not provided.
|
|
The base portion of a segmented entry consists of the following: Sequence number of entry,
|
|
Output queue name for input spooled file, Output queue library name for input spooled file,
|
|
User name for input spooled file, User data for input spooled file,
|
|
Form type for input spooled file and Segmented entry. Fields not used in a specified
|
|
format will be set to blanks ('40'X) for character data, 0 for numeric fields and '00'X
|
|
for reserved fields.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'FFFFFFFF'</em></td>
|
|
<td align="left" valign="top">All entries will be searched. If a listed entry is
|
|
non-segmented, all of the entry's information for the specified format is provided.
|
|
If a listed entry is segmented,
|
|
each segment's information for the specified format is provided.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>sequence-number</em></td>
|
|
<td align="left" valign="top">The sequence number of an entry. If a listed entry is
|
|
non-segmented, all of the entry's information for the specified format is provided.
|
|
If a listed entry is segmented,
|
|
all information for the specified format for each segment is provided. The values for
|
|
the filter determine whether all segments or a subset of the segments are returned.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This field can be used in conjunction with any of the other filter values to subset
|
|
the list of Map entries.</p>
|
|
|
|
<p><strong>Spooled file name for filter.</strong> The name of the spooled file to filter
|
|
on or the name of the spooled file. At
|
|
least one output queue or special value must be specified.
|
|
This field can be used in conjunction with any of the other filter values to subset
|
|
the list of Map entries.</p>
|
|
|
|
<p>The following special value is used for the Spooled file name when filtering:</p>
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">
|
|
Map entries are included in the list regardless of the spooled file name.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This field must be padded with blanks (X'40').</p>
|
|
|
|
<p><strong>User data for filter.</strong> The value of the user data of the Map entry to filter
|
|
on or the value of the user data. At least one user name or special value must be specified.
|
|
This field can be used in conjunction with any of the other filter values to subset
|
|
the list of Map entries.</p>
|
|
|
|
<p>The following special value is used for the user data when filtering:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">
|
|
Map entries are included in the list regardless of the user data.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This field must be padded with blanks (X'40').</p>
|
|
|
|
<p><strong>User name for filter.</strong> The name of the user that created 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 any of the other filter values to subset
|
|
the list of Map entries.</p>
|
|
|
|
<p>The following special value is used for the output queue name when filtering:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">
|
|
Map entries are included in the list regardless of the user name for filter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This field must be padded with blanks (X'40').</p>
|
|
|
|
<br>
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &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">CPF3C3C E</td>
|
|
<td align="left" valign="top">Value for parameter &1 not valid.</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">CPD5F01 D</td>
|
|
<td align="left" valign="top">API &5 detected an internal system failure.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF5F11 E</td>
|
|
<td align="left" valign="top">Format of filter information name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF5F12 E</td>
|
|
<td align="left" valign="top">Length of filter information &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9801 E</td>
|
|
<td align="left" valign="top">Object &2 in library &3 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9802 E</td>
|
|
<td align="left" valign="top">Not authorized to object &2 in &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9803 E</td>
|
|
<td align="left" valign="top">Cannot allocate object &2 in library &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9810 E</td>
|
|
<td align="left" valign="top">Library &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9820 E</td>
|
|
<td align="left" valign="top">Not authorized to use library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library &2 ended.
|
|
Reason code &3.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
<br>
|
|
<hr>
|
|
API introduced: V5R3
|
|
|
|
<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>
|
|
|