ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/xpeprem.htm

182 lines
5.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 Remove</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 Remove</h2>
<div class="box" style="width: 60%;">
<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%">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">Return code</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
</table>
<br>
</div>
<br>
<p>The Preprocessing Exit Program for Remove allows for processing to take
place before an exit program is removed from an exit point. The preprocessing
exit program will notify the registration facility through the return code
parameter whether or not to remove the exit program from 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 exit point name from which the exit program is being removed.</p>
</dd>
<dt><strong>Exit point format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The exit point format name from which the exit program is being removed.</p>
</dd>
<dt><strong>Exit program number</strong></dt>
<dd>INPUT; BINARY(4)
<p>The exit program number of the exit program being removed. 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 associated with the specified exit point
name and exit point format name will be removed.</td>
</tr>
<tr>
<td valign="top"><em>exit program number</em></td>
<td valign="top">Only the exit program with the specified exit program number,
exit point name, and exit point format name will be removed.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Return code</strong></dt>
<dd>OUTPUT; BINARY(4)
<p>A 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 remove the exit program
from the exit point and should return an error to the caller of the Remove Exit
Program API.</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">The registration facility should remove the exit program from
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 Remove Exit Program API.</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">The registration will not remove the exit program information.
The exit point provider removed the exit program 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 Remove
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>