280 lines
8.1 KiB
HTML
280 lines
8.1 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 Add</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 Add</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 75%;">
|
||
|
|
<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%">Exit point name</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(20)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</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">3</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">4</td>
|
||
|
|
<td align="left" valign="top">Qualified exit program name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(20)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">Exit program data</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</td>
|
||
|
|
<td align="left" valign="top">Length of exit program data</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="left" valign="top">Exit program attributes</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</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 Add allows for processing to take place
|
||
|
|
before an exit program is added to an exit point. The preprocessing exit
|
||
|
|
program will notify the registration facility through the return code parameter
|
||
|
|
whether or not to add the exit program to the exit point.</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>Exit point name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(20)
|
||
|
|
|
||
|
|
<p> The name of the exit point to which the exit program is being added.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Exit point format name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p> The format name of the exit point to which the exit program is being
|
||
|
|
added.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Exit program number</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p> The order in which the exit programs are to be run when multiple exit
|
||
|
|
programs are associated with the exit point. The valid range is 1 through
|
||
|
|
2 147 483 647, where the processing sequence is from the lowest
|
||
|
|
number to the highest number. Exit program numbers do not need to be
|
||
|
|
consecutive. The following special values are allowed:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><em>-1</em></td>
|
||
|
|
<td valign="top">The next lowest available number for that specific exit point
|
||
|
|
will be assigned</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><em>-2</em></td>
|
||
|
|
<td valign="top">The highest available number for that specific exit point will
|
||
|
|
be assigned</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p> When the exit point provider stores the exit program information and one of
|
||
|
|
the above special values is specified, the exit point provider will assign the
|
||
|
|
exit program number. Otherwise, the registration facility will assign the exit
|
||
|
|
program number.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Qualified exit program name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(20)
|
||
|
|
|
||
|
|
<p> The exit program that is to be added, and the library in which it is
|
||
|
|
located. The first 10 characters contain the exit program name, and the second
|
||
|
|
10 characters contain the name of the library in which the exit program
|
||
|
|
resides. A specific library name must be specified. The special values *LIBL
|
||
|
|
and *CURLIB are not supported.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Exit program data</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p> The exit program data supplied for the exit program that is requesting to
|
||
|
|
be added to the exit point. Pointer data will not be preserved in the exit
|
||
|
|
program data parameter.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of exit program data</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p> The length of the exit program data. The valid length is 0 through
|
||
|
|
2048.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Exit program attributes</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p> The specified information for the exit program. Refer to <a href=
|
||
|
|
"qusaddep.htm#HDREPATT">Exit Program Attribute Keys</a> for more information.
|
||
|
|
Any field not specified will be given the default value. The information is in
|
||
|
|
the following format:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Number of variable length records</em></dt>
|
||
|
|
|
||
|
|
<dd>BINARY(4)</dd>
|
||
|
|
|
||
|
|
<dd>The total number of all of the variable length records.</dd>
|
||
|
|
|
||
|
|
<dt><em>Variable length records</em></dt>
|
||
|
|
|
||
|
|
<dd>The exit program attributes and their values. Refer to <a href=
|
||
|
|
"qusaddep.htm#HDRFMTVAR1">Format for Variable Length Record</a> for more
|
||
|
|
information.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Return code</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p> Return code to notify success or failure. The following values are
|
||
|
|
allowed:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><em>0</em></td>
|
||
|
|
<td valign="top">The registration facility should not add the exit program to
|
||
|
|
the exit point and should return an error to the caller of the Add Exit Program
|
||
|
|
API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><em>1</em></td>
|
||
|
|
<td valign="top">The registration facility should add the exit program to the
|
||
|
|
exit point. If the exit point provider has specified a Preprocessing Exit
|
||
|
|
Program for Retrieve and returns this return code, an error will be issued to
|
||
|
|
the caller of the Add Exit Program API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><em>2</em></td>
|
||
|
|
<td valign="top">The registration facility will not store the exit program
|
||
|
|
information. The exit point provider stored the information. If the exit point
|
||
|
|
provider has not specified a Preprocessing Exit Program for Retrieve and
|
||
|
|
returns this return code, an error will be issued to the caller of the Add Exit
|
||
|
|
Program API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><em>3</em></td>
|
||
|
|
<td valign="top">The registration facility will not replace the exit program.
|
||
|
|
The exit point provider replaced the exit program. If the exit point provider
|
||
|
|
did not specify a Preprocessing Exit Program for Retrieve and returns this
|
||
|
|
return code, an error is issued to the caller of the Add Exit Program API.</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>
|
||
|
|
Exit program 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>
|
||
|
|
|