320 lines
7.7 KiB
HTML
320 lines
7.7 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>ILE COBOL Error-Handling Exit Procedure</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 ========================================== -->
|
|
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
|
|
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
|
|
<!--File Edited by Kersten Oct 2001 -->
|
|
<!--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>ILE COBOL Error-Handling Exit Procedure</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<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%">COBOL message identification</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(7)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Valid responses to message</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(6)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Name of program issuing error</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(20)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">System message causing COBOL message</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(7)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Length of passed message text</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">Return code</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Message text</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">Module name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="left" valign="top">COBOL program name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(256)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</div>
|
|
|
|
<p>This is a user-defined program that acts as an error handler for an ILE
|
|
COBOL/400 program. Use the Set COBOL Error Handler (QlnSetCobolErrorHandler)
|
|
API to establish this relationship between the two programs.</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>COBOL message identification</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(7)
|
|
|
|
<p>A 3-character prefix followed by a 4-character number.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Valid responses to message</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(6)
|
|
|
|
<p>The list of valid 1-character responses. This list is variable in length and
|
|
consists of uppercase letters in alphabetical order. The list always ends with
|
|
a space.</p>
|
|
|
|
<p>The following are examples of lists of valid responses:</p>
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td valign="top"><em>CG</em></td>
|
|
<td valign="top"> </td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>CDFG</em></td>
|
|
<td valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Name of program issuing error</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The qualified name of the ILE COBOL/400 program that issued the error.</p>
|
|
|
|
<p>The 20 characters of this parameter are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>1-10</em></td>
|
|
<td valign="top">The name of the program object.<br>
|
|
The valid value is:
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td valign="top"><em>program-name</em></td>
|
|
<td valign="top">The name of the program object.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>11-20</em></td>
|
|
<td valign="top">The library where the program object existed.<br>
|
|
The valid value is:
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td valign="top"><em>library-name</em></td>
|
|
<td valign="top">The library where the program object existed.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"></td>
|
|
<td valign="top"></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>System message causing COBOL message</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(7)
|
|
|
|
<p>Some COBOL error messages are issued because of error messages received from
|
|
the system. This parameter identifies such system messages.</p>
|
|
|
|
<p>Valid values are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>*NONE</em></td>
|
|
<td valign="top">No system message is available.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>message-id</em></td>
|
|
<td valign="top">A 3-character message prefix followed by a 4-character
|
|
number.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Length of passed message text</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>If the original message was a system message, the substitution text for the
|
|
system message is passed. In the absence of an original system message,
|
|
Parameter 4 has a value of *NONE, and the substitution text for the COBOL
|
|
message is passed.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Return code</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(1)
|
|
|
|
<p>Must be one of the values specified in Parameter 2, or a space. If the value
|
|
is not one of these, a response of a space is assumed.</p>
|
|
|
|
<p>Valid values are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>blank</em></td>
|
|
<td valign="top">Issue the COBOL message that was passed to the error-handling
|
|
program.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>G</em></td>
|
|
<td valign="top">Continue running the COBOL program.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>C</em></td>
|
|
<td valign="top">End the current COBOL run unit.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>D</em></td>
|
|
<td valign="top">Same as C, but produce a formatted dump of user-defined COBOL
|
|
variables.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>F</em></td>
|
|
<td valign="top">Same as D, but also dump COBOL's file-related internal
|
|
variables.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Message text</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The substitution text of the message. Its length is determined by Parameter
|
|
5.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Module name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The module within the program object that issued the error.</p>
|
|
</dd>
|
|
|
|
<dt><strong>COBOL program name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(256)
|
|
|
|
<p>The name of the COBOL program, from the PROGRAM-ID paragraph, that issued
|
|
the error.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<hr>
|
|
Exit program introduced: V3R2
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center"><td valign="middle" align="center">
|
|
<a href="#Top_Of_Page">Top</a> |
|
|
<a href="hll.htm">High-level language APIs</a> |
|
|
<a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|