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

668 lines
20 KiB
HTML
Raw Permalink Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Remove PDF Map Object Entries (QPQRPME) 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. -->
<!-- QPQRPME SCRIPT A converted by B2H R4.1 (346) (CMS) by PMHALL at -->
<!-- RCHVMW2 on 7 Oct 1998 at 22:42:51 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- 0300508 JETAYLOR html cleanup -->
<!--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>Remove PDF Map Object Entries (QPQRPME) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Number of entries removed</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Entries removed</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Length of entries removed</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Entry lengths and entry offsets</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Array(*) of Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Length of entry lengths and offsets</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Qualified PDF 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">7</td>
<td align="left" valign="top">Maximum number of entries</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Remove criteria</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Remove PDF Map object Entries (QPQRPME) API removes one or more PDF Map object
entries that match the values specified on the remove criteria parameter. It
returns the number of entries that were removed and, optionally, returns the
actual PDF map entries removed.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>PDF Map object Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>PDF Map object Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>PDF Map object Lock</em></dt>
<dd>*SHRUPD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Number of entries removed</strong></dt>
<dd>OUTPUT; BINARY(4)
<p>The number of PDF map entries, satisfying the values specified on the remove
criteria parameter, that were successfully removed from the PDF Map object. If this
field is 0, no entries satisfied the remove criteria. This value can never be
greater than the maximum number of entries parameter.</p>
</dd>
<dt><strong>Entries removed</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The actual entries removed. All entries that satisfied the remove criteria
parameter and were removed (up to the maximum number of entries parameter) are
returned if sufficient space is provided. The API returns only the data that
the area can hold.</p>
<p>If you do not want the entries that were removed to be returned in this
parameter, specify 0 for the length of entries removed parameter.</p>
<p>Every entry removed causes the number of entries removed parameter to be
incremented by 1.</p>
<p>The format of this parameter is the same as the Remove criteria parameter. Refer to <a href="#HDRIDX02">Remove criteria Format</a> for the layout of this
parameter.</p>
</dd>
<dt><strong>Length of entries removed</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the entries removed parameter. If this length is larger than
the actual size of the entries removed parameter, the results may not be
predictable. The minimum length is 0 or &gt;= (greater than or equal to) 8
bytes. If 0 is used, the entries removed from the PDF Map are not returned and
the bytes returned and the bytes available in the entries removed parameter are
not set.</p>
</dd>
<dt><strong>Entry lengths and entry offsets</strong></dt>
<dd>OUTPUT; ARRAY of CHAR(8)
<p>A data structure that contains entry lengths and entry offsets for all
entries that were found that met the remove criteria parameter. An entry length
and entry offset exist for every entry returned in the entries removed
parameter. These entry lengths and entry offsets are used to parse through the
entries removed parameter. If the length of entries removed parameter is 0,
this information will not be returned.</p>
<p>The size of the entry lengths and entry offsets parameter should be at
least:</p>
<pre>
8 + (the maximum number of entries parameter * 8)
</pre>
<p>You must provide enough space in both the entries removed and the entry
lengths and offset parameter for this API to return complete information to
you.</p>
<p>See <a href="#HDRRMV01">Format for Entry Lengths and Entry Offsets</a> for
details on the data structure.</p>
</dd>
<dt><strong>Length of entry lengths and entry offsets</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the entry lengths and entry offsets. If the length is longer
than the entry lengths and entry offsets parameter, the results may not be
predictable. The minimum length is 8. If the length of entries removed
parameter is 0, which means you do not want the entries removed to be returned,
this parameter is ignored.</p>
</dd>
<dt><strong>Qualified PDF Map object name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The PDF Map object from which you want to remove entries, and the library in
which it is located. The first 10 characters contain the PDF Map object name, and
the second 10 characters contain the library name.</p>
<p>You can use these special values for the library name:</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</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Maximum number of entries</strong></dt>
<dd>INPUT; BINARY(4)
<p>The maximum number of PDF Map object entries to be removed that satisfy the
remove criteria. Valid values are 1 through 4095.</p>
</dd>
<dt><strong>Remove criteria</strong></dt>
<dd>INPUT; CHAR(*)
<p>The criteria used to find matches in the PDF Map object.</p>
<p>Refer to <a href="#HDRIDX02">Remove criteria Format</a> for details on the
format.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRRMV01">Format for Entry Lengths and Entry Offsets</a></h3>
<p>The following information is returned in the entry lengths and entry offsets
parameter. This information is needed to parse through the entries removed
parameter. For detailed descriptions of the fields in the table, see <a href=
"#HDRRMV03">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%">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes available</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The following
fields will be repeated. The number of times they are repeated depends on the
length of the entry lengths and entry offsets parameter and the number of
entries actually removed.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Entry offset</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Entry length</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRIDX02">Remove criteria Format</a></h3>
<p>The following information is the format of the remove criteria. The same format is also used for what is returned in the Entries removed parameter. For more details about the fields in the following table, see <a href=
"#HDRRMV03">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%">Sequence number</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 name</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">Output queue library name</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">Spooled file name</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">Job name</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 name</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">User data</td>
</tr>
<tr>
<td align="center" valign="top">74</td>
<td align="center" valign="top">4A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Form type</td>
</tr>
<tr>
<td align="center" valign="top">84</td>
<td align="center" valign="top">54</td>
<td align="left" valign="top">CHAR(250)</td>
<td align="left" valign="top">Mail tag</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRMV03">Field Descriptions</a></h3>
<p><strong>Bytes available.</strong> The length of all data available to
return. All available data is returned if enough space is provided.</p>
<p><strong>Bytes returned.</strong> The length of the data actually
returned.</p>
<p><strong>Entry length.</strong> The length of the entry removed from the PDF Map object. Valid values are 1-2000, depending on how the PDF Map object was
created.</p>
<p><strong>Entry offset.</strong> The number of bytes from the beginning of the
immediately preceding entry to the first byte of the entry returned. For the
first entry, the offset is the number of bytes from the beginning of the
parameter to the first byte of the first entry.</p>
<p><strong>Form type.</strong> The type of forms that should
be loaded on the printer before this spooled file is printed or spooled files whose form type
matches this value are included in the list.
This field can be used in conjunction with any of the other values in the Remove
criteria format to select a list of entries to remove.</p>
<p>The following special values can be used for the form type:</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 removed regardless
of the value for form type.</td>
</tr>
</table>
<p><strong>Job name.</strong> The name of the job that created the spooled file.
This field can be used in conjunction with any of the other values in the Remove
criteria format to select a list of entries to remove.</p>
<p>The following special values can be used for the job name:</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 removed regardless
of the value for job name.</td>
</tr>
</table>
<p><strong>Mail tag.</strong> The value of the mail tag for a spooled file or a spooled
file segment.
This field can be used in conjunction with any of the other values in the Remove
criteria format to select a list of entries to remove.</p>
<p>The following special values can be used for 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 removed regardless
of the value for mail tag.</td>
</tr>
</table>
<p><strong>Output queue library name.</strong> The name of the library where
the output queue resides.</p>
<p>The following special values can be used for the output queue library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The current library for the current job.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list of the current job.</td>
</tr>
</table>
<p><strong>Output queue name.</strong> 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 values in the Remove
criteria format to select a list of entries to remove.</p>
<p>The following special values can be used for the output queue name:</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 removed regardless
of the value for output queue name.</td>
</tr>
</table>
<p><strong>Sequence number.</strong> The user-defined sequence number for an entry.</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 examined. If an entry is non-segmented
and it matches the remove criteria, then it is removed. If an entry is segmented,
only those segments that match the remove criteria will be removed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>sequence-number</em></td>
<td align="left" valign="top">The sequence number of an entry. A single entry will be
examined. If the entry is non-segmented and it matches the remove criteria,
then it is removed. If an entry is segmented, only segments that match the remove
criteria will be removed.</td>
</tr>
</table>
<p>This field can be used in conjunction with any of the other values in the Remove
criteria format to select a list of entries to remove.</p>
<p><strong>Spooled file name.</strong> 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 values in the Remove
criteria format to select a list of entries to remove.</p>
<p>The following special value is used for the output queue name:</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 removed regardless of the spooled file name.</td>
</tr>
</table>
<p><strong>User data.</strong> 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 values in the Remove
criteria format to select a list of entries to remove.</p>
<p>The following special value is used for the user data:</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 removed regardless of the user data.</td>
</tr>
</table>
<p><strong>User name.</strong> The name of the user that created the spooled file. At
least one user name or special value must be specified.
This field can be used in conjunction with any of the other values in the Remove
criteria format to select a list of entries to remove.</p>
<p>The following special value is used for the output queue name:</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 removed regardless of the user name.</td>
</tr>
</table>
<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">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C70 E</td>
<td align="left" valign="top">Length of entries removed parameter is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C76 E</td>
<td align="left" valign="top">Length of lengths and offsets of entries &amp;1 is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C79 E</td>
<td align="left" valign="top">Maximum number of entries &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPD5F01 D</td>
<td align="left" valign="top">API &amp;5 detected an internal system failure.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library &amp;2 ended. Reason
code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: 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">API by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink