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

213 lines
5.0 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<!-- Begin Header records -->
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Collect Hung Job Service Documentation (QPDETHNG) API</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. -->
<!-- Created for V5R4 on 050110 by RBS -->
<!-- Change history: -->
<!-- 050110 RBS New Part -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2><img src="delta.gif" alt="Start of change">Collect Hung Job Service Documentation (QPDETHNG) API
</h2>
<div class="box" style="width: 90%;">
<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%">Job 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">Job user</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">Job number</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(6)</td>
</tr>
<tr>
<td align="center" valign="top">4</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>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Collect Hung Job Service Documentation (QPDETHNG) API dumps documentation associated with the hung
job to help service determine the cause of the hang.
</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>
<dl>
<dt><em>Authority to use the API</em></dt>
<dd>Special authorities needed: *JOBCTL and either *SERVICE or be authorized to the Service Dump
function of i5/OS through iSeries Navigator's Application Administration support. The Change
Function Usage (CHGFCNUSG) command, with a function ID of QIBM_SERVICE_DUMP, can also be
used to change the list of users that are allowed to perform dump operations.
</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Job name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the hung job.</p>
</dd>
<dt><strong>Job user</strong></dt>
<dd>INPUT; CHAR(10)
<p>The user of the hung job.</p>
</dd>
<dt><strong>Job number</strong></dt>
<dd>INPUT; CHAR(6)
<p>The number of the hung job.</p>
</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><a name="errmsg">Error Messages</a></h3>
<p>The following messages may be sent from this function:</p>
<table width="100%">
<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">CPF3CF1</td>
<td width="85%" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td>CPF3CF2</td>
<td>Error(s) occurred during running of * API.</td>
</tr>
<tr>
<td>CPFC1D</td>
<td>Input variable length in parameter * not
valid.</td>
</tr>
<tr>
<td>CPF3C1E</td>
<td>Required parameter * omitted.</td>
</tr>
<tr>
<td>CPF3C17</td>
<td>Error occurred with input data parameter.</td>
</tr>
<tr>
<td>CPF3C21</td>
<td>Format name * is not valid.</td>
</tr>
<tr>
<td>CPF3C4A</td>
<td>Value not valid for field *.</td>
</tr>
<tr>
<td>CPF3C4B</td>
<td>Value not valid for field *.</td>
</tr>
<tr>
<td>CPF3C4C</td>
<td>Value not valid for field *.</td>
</tr>
<tr>
<td>CPF9872</td>
<td>Program or service program * in library * ended.
Reason code *.</td>
</tr>
</table>
<br>
<br>
<img src="deltaend.gif" alt="End of change">
<hr>
API introduced: V5R4
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"pm1.htm">Problem Management APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>