234 lines
6.5 KiB
HTML
234 lines
6.5 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 Debug Attribute (QteRetrieveDebugAttribute) 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. -->
|
|
<!-- DEBUG1 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
|
<!-- at RCHVMW2 on 29 Jan 1999 at 16:05:09 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File Edited November 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 Debug Attribute (QteRetrieveDebugAttribute) API</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
<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%">Debug attribute</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">Attribute value</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(10)</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>
|
|
Service Program: QTEDBGS<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Retrieve Debug Attribute (QteRetrieveDebugAttribute) API is used to retrieve the attributes of the source debug session. These attributes may be any of the following:</p>
|
|
|
|
<ul>
|
|
<li>Default attributes established when the debug session was started<br><br></li>
|
|
|
|
<li>Attributes changed with the Set Debug Attribute API<br><br></li>
|
|
|
|
<li>Attributes changed by the Change Debug (CHGDBG) command</li>
|
|
</ul>
|
|
|
|
<p>The attributes of the debug environment cannot be retrieved unless the job is currently in debug mode.</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>Debug attribute</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the debug environment attribute that is retrieved. The valid values for this parameter are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>*UPDPROD</em></td>
|
|
<td valign="top">Retrieves the value of the update production files attribute.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*DEBUGJOB</em></td>
|
|
<td valign="top">Retrieves an indicator of which job is being debugged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*OPMSRC</em></td>
|
|
<td valign="top">Retrieves the value of the OPM source debug attribute.</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Attribute value</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(10)
|
|
|
|
<p>The current value of the attribute identified in the debug attribute
|
|
parameter.</p>
|
|
|
|
<p>When the debug attribute parameter contains *UPDPROD, the attribute
|
|
value parameter can have one of the following values:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td valign="top"><em>*YES</em></td>
|
|
<td valign="top">Allow the updating of production files while in debug mode.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*NO</em></td>
|
|
<td valign="top">Do not allow the updating of production files while in debug mode.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>When the debug attribute parameter contains *DEBUGJOB, the attribute value parameter can have one of the following values:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>*LOCAL</em></td>
|
|
<td valign="top">The debug session is debugging programs that run in the job in which this API is running.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*REMOTE</em></td>
|
|
<td valign="top">The debug session is debugging programs that run in the job specified in the Start Service Job (STRSRVJOB) command.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>When the debug attribute parameter contains *OPMSRC, the attribute value parameter can have one of the following values:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td valign="top"><em>*YES</em></td>
|
|
<td valign="top">Allow OPM programs that have source debug data to be debugged by using the ILE debug APIs.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*NO</em></td>
|
|
<td valign="top">Do not allow OPM programs to be debugged by using the ILE debug APIs.</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">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9541 E</td>
|
|
<td valign="top">Not in debug mode.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9549 E</td>
|
|
<td valign="top">Error addressing API parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9559 E</td>
|
|
<td valign="top">Debug attribute parameter not valid.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V2R3
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center">
|
|
<a href="#top_Of_Page">Top</a> |
|
|
<a href="debug1.htm">Debugger APIs</a> |
|
|
<a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
|
|
<br>
|
|
</body>
|
|
</html>
|
|
|