223 lines
5.6 KiB
HTML
223 lines
5.6 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>Retrieve COBOL Error Handler (QLRRTVCE) API</title>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- 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. -->
|
|
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
|
|
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--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>Retrieve COBOL Error Handler (QLRRTVCE) API</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%">Current or pending error-handling
|
|
exit program name</td>
|
|
<td align="left" valign="top" width="20%">Output</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">Scope of error-handling exit program</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Retrieve COBOL Error Handler (QLRRTVCE) API allows you to retrieve the
|
|
name of the current or pending COBOL error-handling program. You can call it
|
|
from any programming language; however, this API only retrieves the name of the
|
|
error handling program that is called when an error occurs in an OPM COBOL/400
|
|
program.</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>Current or pending error-handling exit program name</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(20)
|
|
|
|
<p>The qualified name of the error-handling program for the current or pending
|
|
COBOL run unit.</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>
|
|
Valid values are:<br>
|
|
<br>
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td valign="top"><em>*NONE</em></td>
|
|
<td valign="top">No user-defined COBOL error handler has been set.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>program-name</em></td>
|
|
<td valign="top">The name of the error-handling program.</td>
|
|
</tr>
|
|
</table>
|
|
</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:<br>
|
|
<br>
|
|
|
|
|
|
<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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Scope of error-handling exit program</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The program can apply to a current or pending run unit.</p>
|
|
|
|
<p>Valid values are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td valign="top"><em>C</em></td>
|
|
<td valign="top">Current COBOL run unit</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>P</em></td>
|
|
<td valign="top">Pending COBOL run unit</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="3">
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C90 E</td>
|
|
<td width="85%" valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">LBE7040 E</td>
|
|
<td valign="top">Format of error code parameter is not correct.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">LBE7051 E</td>
|
|
<td valign="top">Scope parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">LBE7052 E</td>
|
|
<td valign="top">Run unit specified for error handler does not exist.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">LBE7055 E</td>
|
|
<td valign="top">Severe error while addressing parameter list. The API did not
|
|
complete.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V3R6
|
|
|
|
<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>
|