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

240 lines
7.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>Service Entry Point Stop Handler Exit Program</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 -->
<!-- New for V5R2 -->
<!-- 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Service Entry Point Stop Handler Exit Program</h2>
<div class="box" style="width: 70%;">
<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%">Qualified program name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Program type</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 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">Stop information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Fully qualified job name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(30)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;QSYSINC Member Name: ETEPSEPH<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>Service Entry Point Stop Handler exit program</strong> is a
user-written program that handles the service entry point program-stop
condition.</p>
<p>This program must be identified to the Source Debugger support with the
Register Service Entry Point Handler (QteRegSrvEntPntStpHdlr) API.</p>
<p>The location at which the service entry point was encountered is specified
in the stop information parameter and is in terms of the statement view. The
user-supplied program may use the Map View Position (QteMapViewPosition) API to
determine the location to which this program maps any other registered
view.</p>
<p>Debugging of threaded jobs is enabled by the thread ID field that is
contained in the parameters passed to the stop handler. Threads debugging is
supported if a service job is used to debug a job that was spawned by native
threads support. For nonthreaded applications, the thread ID passed will always
be that of the initial job thread.</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>Qualified program name</strong></dt>
<dd>INPUT; CHAR(*)
<p>The format of this parameter is dependent on the program type parameter. If
the program type is *PGM or *SRVPGM, the format of this parameter is as
follows:</p>
<ul>
<li>The name of the program that is stopped as a result of a service entry
point.</li>
<li>The first 10 characters contain the name of the program. The second 10
characters contain the name of the library where the program is located. Each
name is left-justified.</li>
</ul>
<p>If the program type is *CLASS, the format of this parameter is as
follows:</p>
<ul>
<li>The null-terminated class file name of the JAVA class.</li>
</ul>
<br>
</dd>
<dt><strong>Program type</strong></dt>
<dd>INPUT; CHAR(10)
<p>The object type of the program that is stopped.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*PGM</em></td>
<td align="left" valign="top">Bound program or OPM program</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SRVPGM</em></td>
<td align="left" valign="top">Service program</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CLASS</em></td>
<td align="left" valign="top">JAVA class file</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Module name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the module (left-justified) that is stopped. The value of this
field is blank for OPM programs and JAVA class files.</p>
</dd>
<dt><strong>Stop information</strong></dt>
<dd>INPUT; CHAR(*)
<p>A list of locations within the statement view where the program stop
condition occurred.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>Thread ID</em></td>
<td align="left" valign="top">CHAR(8)<br>
The thread identification of the thread where the program is stopped.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Offset to stopped locations</em></td>
<td align="left" valign="top">BINARY(4)<br>
The offset from the start of the stop information to the first stop
location.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>Number of stopped locations</em></td>
<td align="left" valign="top">BINARY(4)<br>
The number of positions stored in the stop information parameter. In some
cases, it is not known exactly where a program is stopped; therefore, multiple
positions are given. Each entry specifies one position in the statement view.
This number is not less than one nor greater than three. At least one stopped
position will be identified; if stopped at more than one position, no more than
the first three positions are made available.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Stopped locations</em></td>
<td align="left" valign="top">Array of BINARY(4)<br>
The line number in the statement view where the program is stopped.</td>
</tr>
</table>
</dd>
<dt><strong>Fully qualified job name</strong></dt>
<dd>INPUT; CHAR(30)
<p>The name of the job in which the program stop condition occurred. The fully
qualified job name consists of three parts. The first 10 characters contain the
job name. The next 10 characters contain the user name. The last 10 characters
contain the 6-character job number followed by 4 blanks.</p>
</dd>
</dl>
<hr>
Exit program introduced: V5R2
<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>
</body>
</html>