friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0332907f0f
ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzalu_5.4.0.1/rzalunpsf.htm

271 lines
11 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="dc.language" scheme="rfc1766" content="en-us" />
<!-- 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. -->
<meta name="dc.date" scheme="iso8601" content="2005-09-06" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow"/>
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<title>Exit point QIBM_QNPS_SPLF</title>
<link rel="stylesheet" type="text/css" href="ibmidwb.css" />
<link rel="stylesheet" type="text/css" href="ic.css" />
</head>
<body>
<a id="Top_Of_Page" name="Top_Of_Page"></a><!-- Java sync-link -->
<script language = "Javascript" src = "../rzahg/synch.js" type="text/javascript"></script>
<a name="rzalunpsf"></a>
<h5 id="rzalunpsf">Exit point QIBM_QNPS_SPLF</h5>
<p>Exit point QIBM_QNPS_SPLF is used by exit programs that process spooled
files. The called exit program is passed four parameters. These parameters
are pointers to structures in user domain storage. These structures, collectively,
comprise format SPLF0100.</p>
<p><span class="bold">Required parameters</span></p><blockquote>
<p><span class="bold">Required parameter group</span></p>
<a name="wq85"></a>
<table id="wq85" width="100%" summary="" border="0" frame="void" rules="none">
<tbody valign="top">
<tr>
<td width="25%" align="right" valign="top">1</td>
<td width="25%" align="left" valign="top">Return code</td>
<td width="25%" align="left" valign="top">Output</td>
<td width="25%" align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="right" valign="top">2</td>
<td align="left" valign="top">Server information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(32)</td>
</tr>
<tr>
<td align="right" valign="top">3</td>
<td align="left" valign="top">Spooled file ID</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(40)</td>
</tr>
<tr>
<td align="right" valign="top">4</td>
<td align="left" valign="top">Spooled file exit program data</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
</tbody>
</table>
<p></p>
<dl class="parml">
<dt class="bold">Return code</dt>
<dd>OUTPUT; CHAR(1) The return code is a pointer to a structure in user
domain that contains the return code from the exit program. The return code
is checked on return from the call to the exit program.
<p>Any nonzero code
indicates an error with the exit program. The exit program being called must
log any specific errors. Processing by the network print server continues.</p>
</dd>
</dl>
<a name="wq86"></a>
<table id="wq86" width="100%" summary="" border="1" frame="border" rules="all">
<thead valign="bottom">
<tr>
<th id="wq87" colspan="2" align="center" valign="bottom">Offset</th>
<th id="wq88" width="25%" rowspan="2" align="left" valign="bottom">Type</th>
<th id="wq89" width="25%" rowspan="2" align="left" valign="bottom">Field</th>
</tr>
<tr>
<th id="wq90" width="25%" align="left" valign="bottom">Dec</th>
<th id="wq91" width="25%" align="left" valign="bottom">Hex</th>
</tr>
</thead>
<tbody valign="top">
<tr>
<td align="center" valign="top" headers="wq87 wq90">0</td>
<td align="center" valign="top" headers="wq87 wq91">0</td>
<td align="left" valign="top" headers="wq88">CHAR(1)</td>
<td align="left" valign="top" headers="wq89">Return code</td>
</tr>
</tbody>
</table>
<dl class="parml">
<dt class="bold">Server information</dt>
<dd>INPUT; CHAR(32) The server information structure contains the user profile
name, server identifier, format name, and server function identifier.
</dd>
</dl>
<p>The structure of server information is:</p>
<a name="wq92"></a>
<table id="wq92" width="100%" summary="" border="1" frame="border" rules="all">
<thead valign="bottom">
<tr>
<th id="wq93" colspan="2" align="center" valign="bottom">Offset</th>
<th id="wq94" width="25%" rowspan="2" align="left" valign="bottom">Type</th>
<th id="wq95" width="25%" rowspan="2" align="left" valign="bottom">Field</th>
</tr>
<tr>
<th id="wq96" width="25%" align="left" valign="bottom">Dec</th>
<th id="wq97" width="25%" align="left" valign="bottom">Hex</th>
</tr>
</thead>
<tbody valign="top">
<tr>
<td align="center" valign="top" headers="wq93 wq96">0</td>
<td align="center" valign="top" headers="wq93 wq97">0</td>
<td align="left" valign="top" headers="wq94">CHAR(10)</td>
<td align="left" valign="top" headers="wq95">User profile name</td>
</tr>
<tr>
<td align="center" valign="top" headers="wq93 wq96">10</td>
<td align="center" valign="top" headers="wq93 wq97">A</td>
<td align="left" valign="top" headers="wq94">CHAR(10)</td>
<td align="left" valign="top" headers="wq95">Server identifier</td>
</tr>
<tr>
<td align="center" valign="top" headers="wq93 wq96">20</td>
<td align="center" valign="top" headers="wq93 wq97">14</td>
<td align="left" valign="top" headers="wq94">CHAR(8)</td>
<td align="left" valign="top" headers="wq95">Format name</td>
</tr>
<tr>
<td align="center" valign="top" headers="wq93 wq96">28</td>
<td align="center" valign="top" headers="wq93 wq97">1C</td>
<td align="left" valign="top" headers="wq94">BINARY(4)</td>
<td align="left" valign="top" headers="wq95">Function identifier</td>
</tr>
</tbody>
</table>
<dl class="parml">
<dt class="bold">Spooled file ID</dt>
<dd>INPUT; CHAR(40) The spooled file ID structure contains the job name,
user name, job number, spooled file name, and spooled file number. This information
uniquely identifies a spooled file on the i5/OS.
</dd>
</dl>
<p>The structure of a spooled file ID is:</p>
<a name="wq98"></a>
<table id="wq98" width="100%" summary="" border="1" frame="border" rules="all">
<thead valign="bottom">
<tr>
<th id="wq99" colspan="2" align="center" valign="bottom">Offset</th>
<th id="wq100" width="25%" rowspan="2" align="left" valign="bottom">Type</th>
<th id="wq101" width="25%" rowspan="2" align="left" valign="bottom">Field</th>
</tr>
<tr>
<th id="wq102" width="25%" align="left" valign="bottom">Dec</th>
<th id="wq103" width="25%" align="left" valign="bottom">Hex</th>
</tr>
</thead>
<tbody valign="top">
<tr>
<td align="center" valign="top" headers="wq99 wq102">0</td>
<td align="center" valign="top" headers="wq99 wq103">0</td>
<td align="left" valign="top" headers="wq100">CHAR(10)</td>
<td align="left" valign="top" headers="wq101">Job name</td>
</tr>
<tr>
<td align="center" valign="top" headers="wq99 wq102">10</td>
<td align="center" valign="top" headers="wq99 wq103">A</td>
<td align="left" valign="top" headers="wq100">CHAR(10)</td>
<td align="left" valign="top" headers="wq101">User name</td>
</tr>
<tr>
<td align="center" valign="top" headers="wq99 wq102">20</td>
<td align="center" valign="top" headers="wq99 wq103">14</td>
<td align="left" valign="top" headers="wq100">CHAR(6)</td>
<td align="left" valign="top" headers="wq101">Job number</td>
</tr>
<tr>
<td align="center" valign="top" headers="wq99 wq102">26</td>
<td align="center" valign="top" headers="wq99 wq103">1A</td>
<td align="left" valign="top" headers="wq100">CHAR(10)</td>
<td align="left" valign="top" headers="wq101">Spooled file name</td>
</tr>
<tr>
<td align="center" valign="top" headers="wq99 wq102">36</td>
<td align="center" valign="top" headers="wq99 wq103">24</td>
<td align="left" valign="top" headers="wq100">BINARY(4)</td>
<td align="left" valign="top" headers="wq101">Spooled file number</td>
</tr>
</tbody>
</table>
<dl class="parml">
<dt class="bold">Spooled file exit program data</dt>
<dd>INPUT; CHAR(*) The spooled file exit program data information structure
contains a 4-byte length and the spooled file exit program data. The contents
of the spooled file exit program data is not known to the network print server.
The receiving exit program knows the structure of the spooled file exit program
data. For example, if the exit program was going to fax the spooled file specified
by the spooled file ID, the spooled file exit program data could consist of
a name, telephone number, building number, and office location.
</dd>
</dl>
<p>The structure of the spooled file exit program data is:</p>
<a name="wq104"></a>
<table id="wq104" width="100%" summary="" border="1" frame="border" rules="all">
<thead valign="bottom">
<tr>
<th id="wq105" colspan="2" align="center" valign="bottom">Offset</th>
<th id="wq106" width="25%" rowspan="2" align="left" valign="bottom">Type</th>
<th id="wq107" width="25%" rowspan="2" align="left" valign="bottom">Field</th>
</tr>
<tr>
<th id="wq108" width="25%" align="left" valign="bottom">Dec</th>
<th id="wq109" width="25%" align="left" valign="bottom">Hex</th>
</tr>
</thead>
<tbody valign="top">
<tr>
<td align="center" valign="top" headers="wq105 wq108">0</td>
<td align="center" valign="top" headers="wq105 wq109">0</td>
<td align="left" valign="top" headers="wq106">BINARY(4)</td>
<td align="left" valign="top" headers="wq107">Length of the spooled file exit program data</td>
</tr>
<tr>
<td align="center" valign="top" headers="wq105 wq108">4</td>
<td align="center" valign="top" headers="wq105 wq109">4</td>
<td align="left" valign="top" headers="wq106">CHAR(*)</td>
<td align="left" valign="top" headers="wq107">Spooled file exit program data</td>
</tr>
</tbody>
</table></blockquote>
<p><span class="bold">Parameter field descriptions</span></p><blockquote>
<dl>
<dt class="bold">Format name</dt>
<dd>The name of the format being used.
For spooled file support the value is SPLF0100.</dd>
<dt class="bold">Function identifier</dt>
<dd>This parameter identifies,
within a server, the function of the exit point. For spooled file support,
the value is hex 010D.</dd>
<dt class="bold">Job name</dt>
<dd>The name of the job that created the spooled
file.</dd>
<dt class="bold">Job number</dt>
<dd>The number of the job that created the
spooled file.</dd>
<dt class="bold">Server identifier</dt>
<dd>This parameter identifies the
i5/OS server being called. The value for the network print server is QNPSERVR.</dd>
<dt class="bold">Spooled file exit program data</dt>
<dd>Additional information
used by the exit program that is registered for exit point QIBM_QNPS_SPLF.
The client application provides the spooled file exit program data.</dd>
<dt class="bold">Spooled file name</dt>
<dd>The name of the spooled file
being requested.</dd>
<dt class="bold">Spooled file number</dt>
<dd>The number of the spooled file
being requested.</dd>
<dt class="bold">User profile name</dt>
<dd>The user, from IBM eServer iSeries
Access for Windows, that is making the call to the network print server.</dd></dl></blockquote>
<a id="Bot_Of_Page" name="Bot_Of_Page"></a>
</body>
</html>
Reference in New Issue Copy Permalink