376 lines
9.2 KiB
HTML
376 lines
9.2 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>Dump COBOL (QlnDumpCobol) 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 April 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>Dump COBOL (QlnDumpCobol) API</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%">Program object name</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Library name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Module object name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Program object type</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Dump type</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</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>
|
|
Service Program: QLNRMAIN<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Dump COBOL (QlnDumpCobol) API allows you to perform a formatted dump of
|
|
an ILE COBOL/400 program. You can call it from any ILE program; however, if the
|
|
calling program is not an ILE COBOL/400 program, only a data dump will be
|
|
performed. Message CPF955F will be issued if this API is called to dump any
|
|
module other than those created by the ILE COBOL/400 compiler.</p>
|
|
|
|
<p>This API provides two types of dumps, a data dump and an extended dump. The
|
|
data dump contains the following information:</p>
|
|
|
|
<ul>
|
|
<li>The name of each variable</li>
|
|
|
|
<li>The data type</li>
|
|
|
|
<li>The default value</li>
|
|
|
|
<li>The hexadecimal value</li>
|
|
</ul>
|
|
|
|
<p><strong>Note:</strong> Only the first 250 characters of the values will be
|
|
shown in the dump.</p>
|
|
|
|
<p>The extended dump contains the following additional information:</p>
|
|
|
|
<ul>
|
|
<li>The name of each file</li>
|
|
|
|
<li>The system name of each file</li>
|
|
|
|
<li>External/internal flag</li>
|
|
|
|
<li>Open/close status</li>
|
|
|
|
<li>Last I/O operation attempted</li>
|
|
|
|
<li>Last file status</li>
|
|
|
|
<li>Last extended status</li>
|
|
|
|
<li>Blocking information</li>
|
|
|
|
<li>Blocking factor</li>
|
|
|
|
<li>Linage-counter value</li>
|
|
|
|
<li>I/O feedback area information</li>
|
|
|
|
<li>Open feedback area information</li>
|
|
</ul>
|
|
|
|
<p>Variable values may only be requested if an active call stack entry exists
|
|
for the module object specified in the job in which this API is called. Values
|
|
existing in program static or automatic storage are not accessible by this API
|
|
unless the program object has a current call stack entry. All variables that
|
|
were defined by the compiler and stored in the module object's HLL symbol table
|
|
will be returned.</p>
|
|
|
|
<p>Also, the module object for which variable information is requested must
|
|
contain debug data. Thus, the module object must be compiled with a *DBGVIEW
|
|
option other than *NONE.</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>Program object name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the program to be dumped. If this parameter is omitted, the
|
|
program object name of the caller is used.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Library name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the library in which the program to be dumped is found. *CURLIB
|
|
and *LIBL can be specified as valid values to indicate the current library and
|
|
the library list, respectively. If this parameter is omitted, the library
|
|
associated with the calling program is used.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Module object name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the module, within the specified program, to be dumped. If this
|
|
parameter is omitted, the module object name of the caller is used.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Program object type</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The object type of the program object.</p>
|
|
|
|
<p>Valid values are:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="15%" valign="top"><em>*PGM</em></td>
|
|
<td width="85%" valign="top">Program object</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*SRVPGM</em></td>
|
|
<td valign="top">Service program</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Dump type</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The type of dump.</p>
|
|
|
|
<p>Valid values are:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="10%" valign="top"><em>D</em></td>
|
|
<td width="90%" valign="top">Data dump. Gives a dump of the COBOL
|
|
identifiers.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>F</em></td>
|
|
<td valign="top">Extended dump. Gives a dump of COBOL identifiers and
|
|
file-related information.</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">CPF3C21 E</td>
|
|
<td width="85%" valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C90 E</td>
|
|
<td valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF2 E</td>
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9549 E</td>
|
|
<td valign="top">Error addressing API parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF954F E</td>
|
|
<td valign="top">Module &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF955F E</td>
|
|
<td valign="top">Program &1 not a bound program.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9562 E</td>
|
|
<td valign="top">Module &1 cannot be debugged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF956D E</td>
|
|
<td valign="top">Parameter does not match on continuation request.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF956E E</td>
|
|
<td valign="top">Program language of module not supported.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF956F E</td>
|
|
<td valign="top">Continuation handle parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9573 E</td>
|
|
<td valign="top">Program type parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9574 E</td>
|
|
<td valign="top">Call stack entry does not exist.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9579 E</td>
|
|
<td valign="top">Data option specified not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9801 E</td>
|
|
<td valign="top">Object &2 in library &3 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9802 E</td>
|
|
<td valign="top">Not authorized to object &2 in &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9803 E</td>
|
|
<td valign="top">Cannot allocate object &2 in library &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9809 E</td>
|
|
<td valign="top">Library &1 cannot be accessed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9810 E</td>
|
|
<td valign="top">Library &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9820 E</td>
|
|
<td valign="top">Not authorized to use library &1.</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>
|