291 lines
8.0 KiB
HTML
291 lines
8.0 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>Preprocessing Exit Program for Retrieve</title>
|
|
<!-- 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. -->
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!--File cleanup completed by Janet Brauckman, Sept 2001 -->
|
|
<!--End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
|
|
<!--Java sync-link-->
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
<a name="top"></a>
|
|
<h2>Preprocessing Exit Program for Retrieve</h2>
|
|
|
|
<div class="box" style="width: 70%;">
|
|
<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%">Continuation handle</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(16)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Receiver variable</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 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">4</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">5</td>
|
|
<td align="left" valign="top">Exit point name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(20)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Exit point 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">7</td>
|
|
<td align="left" valign="top">Exit program number</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">Exit program selection 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">Return code</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Preprocessing Exit Program for Retrieve allows for the exit point
|
|
provider to store the exit program information. The registration facility will
|
|
not store the exit program information, only exit point information. The
|
|
Preprocessing Exit Program for Add and the Preprocessing Exit Program for
|
|
Remove are required when this preprocessing exit program is supplied. The
|
|
preprocessing exit program will notify the registration facility through the
|
|
return code parameter whether or not the exit information returned is complete
|
|
and accurate.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Continuation handle</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(16)
|
|
|
|
<p> The value returned to the API in the receiver variable when partial
|
|
information is returned. This parameter is used when there is more information
|
|
available to return than what could fit in the receiver variable.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p> The variable in which the preprocessing exit program will return the exit
|
|
information to the registration facility. This information must be returned in
|
|
the format specified in the format name parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p> The length of the receiver variable.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p> The format of the exit information to be returned. One of the following
|
|
format names will be specified by the Retrieve Exit Information API:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>EXTI0100</em></td>
|
|
<td valign="top">Exit point information</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>EXTI0200</em></td>
|
|
<td valign="top">Basic exit program information</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>EXTI0300</em></td>
|
|
<td valign="top">Complete exit program information</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p> Refer to <a href="qusrtvei.htm#HDREXINF1">EXTI0100 Format</a>, <a href=
|
|
"qusrtvei.htm#HDREXINF2">EXTI0200 Format</a>, and <a href=
|
|
"qusrtvei.htm#HDREXINF3">EXTI0300 Format</a> for more information.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Exit point name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p> The name of the exit point for which information is being retrieved.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Exit point format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format name associated with the exit point.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Exit program number</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p> The number of the exit program. When format EXTI0100 is specified, this
|
|
field should be ignored. The following values are allowed:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>-1</em></td>
|
|
<td valign="top">All exit programs for the exit point are returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>exit program number</em></td>
|
|
<td valign="top">The exit program with the specified exit program number is
|
|
returned. The valid range is 1 through 2 147 483 647.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Exit program selection criteria</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p> The selection criteria to be used when selecting which exit programs
|
|
associated with the exit point are to be returned. When format EXTI0100 is
|
|
specified, this field should be ignored. The information is in the following
|
|
format:</p>
|
|
|
|
<dl>
|
|
<dt><em>Number of selection criteria</em></dt>
|
|
|
|
<dd>BINARY(4)</dd>
|
|
|
|
<dd>The total number of selection criteria. Zero is specified if no selection
|
|
criteria are specified. The maximum value for this field is 1.</dd>
|
|
|
|
<dt><em>Selection criteria array</em></dt>
|
|
|
|
<dd>CHAR(*)</dd>
|
|
|
|
<dd>The selection criteria. Refer to <a href="qusrtvei.htm#HDRSELCR">Format for
|
|
Exit Program Selection Criteria</a> for more information.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Return Code</strong></dt>
|
|
|
|
<dd>OUTPUT; BINARY(4)
|
|
|
|
<p> The return code to notify success or failure. If there is no information to
|
|
return, set the number of exit programs returned field to 0 and specify success
|
|
(1) for the return code. The following values are allowed:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td valign="top"><em>0</em></td>
|
|
<td valign="top">The information returned to the registration facility is
|
|
incomplete or inaccurate.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1</em></td>
|
|
<td valign="top">The information returned to the registration facility is
|
|
complete and accurate.</td>
|
|
</tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<p>Error notification is done through the return code parameter. No error
|
|
messages will be accepted.</p>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V3R1
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#top">Top</a> | <a href="reg1.htm">
|
|
Registration Facility APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|