377 lines
9.6 KiB
HTML
377 lines
9.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>Delete Problem Log Entry (QsxDeleteProblemLogEntry) 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. -->
|
|
<!-- QSXDLTPL SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
|
|
<!-- at RCHVMW2 on 2 Oct 1998 at 13:03:19 -->
|
|
<!-- 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>Delete Problem Log Entry (QsxDeleteProblemLogEntry) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<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%">Handle</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Key structures</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Array of Pointers</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Number of keys</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Service Program: QSXSRVPL<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Delete Problem Log Entry (QsxDeleteProblemLogEntry) API provides
|
|
one of the following functions:</p>
|
|
|
|
<ul>
|
|
<li>Deletes a single problem log entry.
|
|
|
|
<p>The problem log entry and all associated data is deleted.</p>
|
|
</li>
|
|
|
|
<li>Removes data from a problem log entry.</li>
|
|
</ul>
|
|
|
|
<p>The data that can be removed by the API are:</p>
|
|
|
|
<ul>
|
|
<li>Key group 2000 (FRU entries). Either all FRU entries or all FRU
|
|
entries of a class are removed. Individual FRU entries cannot be
|
|
removed.</li>
|
|
|
|
<li>Key group 4000 (supported data entries). Either all supporting data
|
|
entries are removed or all entries of a type.</li>
|
|
|
|
<li>PTF entries can be deleted individually, using key 7001 (PTF ID), or
|
|
they can be deleted entirely using key 7000 (PTF entry).</li>
|
|
</ul>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>API Public Authority</em></dt>
|
|
|
|
<dd>*USE</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Handle</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>An identifier that associates the problem log services started with the
|
|
QsxStartProblemLogServices API.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Key structures</strong></dt>
|
|
|
|
<dd>INPUT; Array of Pointers
|
|
|
|
<p>Array of pointers to the data contained in each key being passed to the
|
|
API.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Number of keys</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>Tells the API how many keys are being passed to it.</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>Format of the Key Groups</h3>
|
|
|
|
<p>Depending on the type of problem entry being deleted, one or more key
|
|
groups must be provided to remove the data required or desired to the
|
|
problem. You must select the keys applicable to the problem data you are
|
|
deleting. If the keys provided to the API do not match the requirements
|
|
for the problem log entry type you are deleting, you are notified by the
|
|
error handling procedures.</p>
|
|
|
|
<p>For details about the keys that may be used see <a href=
|
|
"pmkeygroups.htm">Key Groups for Problem Log APIs</a> .</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRDLTRULE">Rules for Key Usage</a></h3>
|
|
|
|
<p>The Delete Problem Log Entry API can be used to:</p>
|
|
|
|
<ul>
|
|
<li>Delete the problem log entry.</li>
|
|
|
|
<li>To delete specific entries from the problem log.
|
|
|
|
<p>The specific data that can be deleted are:</p>
|
|
|
|
<ul>
|
|
<li>Key 2000 (class of FRU entries) to remove all FRU entries or all FRU
|
|
entries of a class</li>
|
|
|
|
<li>Key 7000 (PTF entry) to remove all PTF entries</li>
|
|
|
|
<li>Key group 4000 (supporting data entries) to remove all supporting data
|
|
entries, or all spooled file entries or all data file records as a group.
|
|
Individual entries cannot be removed.</li>
|
|
|
|
<li>Key 7001 (PTF ID) to remove a single PTF entry</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>Deleting the above in any combination is supported.</p>
|
|
|
|
<p>The status of a problem log is not changed as a result of the delete
|
|
operation.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h4>Delete a Problem Log Entry</h4>
|
|
|
|
<p>To delete a problem log entry, provide a key 1 (problem log ID) with no
|
|
other keys. This deletes the problem log entry and all associated data. To
|
|
delete the problem, it must be in CLOSED status or be older than the
|
|
period defined by system value QPRBHLDITV.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h4>Delete FRU Entries</h4>
|
|
|
|
<p>Individual FRU entries cannot be deleted. FRU entries are deleted by
|
|
class. For example, to delete the point of failure FRUs, use key 2000 and
|
|
set the class field to 1. All point of failure FRUs are deleted.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h4>Delete PTF Entries</h4>
|
|
|
|
<p>PTF entries can be deleted individually, using key 7001 (PTF ID), or
|
|
they can be deleted entirely using key 7000 (PTF entry).</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h4>Delete Supporting Data</h4>
|
|
|
|
<p>Individual supporting data entries cannot be deleted. The entry in the
|
|
problem log is deleted and the data defined by the entry is also deleted.
|
|
For example, if a spooled file entry is defined, the problem log contains
|
|
the name of the object to be deleted. The spooled file and the problem log
|
|
entry containing the spooled file name are both deleted. Provide the
|
|
following data:</p>
|
|
|
|
<ul>
|
|
<li>Key 1 (problem log ID)</li>
|
|
|
|
<li>Key group 4000 (supported data entries) deletes all entries or all
|
|
entries of a type.</li>
|
|
</ul>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<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">CPF3C1E E</td>
|
|
<td width="85%" valign="top">Required parameter &1 omitted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td align="left" valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
|
<td align="left" valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7AAB E</td>
|
|
<td align="left" valign="top">Problem &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C4D D</td>
|
|
<td align="left" valign="top">Length &1 for key &2 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C82 D</td>
|
|
<td align="left" valign="top">Key &1 not valid for API &2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C86 D</td>
|
|
<td align="left" valign="top">Required key &1 not specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7AA6 D</td>
|
|
<td align="left" valign="top">Problem record &1 cannot be deleted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPD7A82 D</td>
|
|
<td align="left" valign="top">Value not valid for key &1. (char string)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPD7A87 D</td>
|
|
<td align="left" valign="top">Key &1 may be added only once.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPD7A89 D</td>
|
|
<td align="left" valign="top">Record &1 was not deleted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPD7A8A D</td>
|
|
<td align="left" valign="top">Key value &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7A89 E</td>
|
|
<td align="left" valign="top">Incorrect handle for this activation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7A8A E</td>
|
|
<td align="left" valign="top">Problem log services not started.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7AA6 E</td>
|
|
<td align="left" valign="top">Problem record &1 cannot be deleted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7AA7 E</td>
|
|
<td align="left" valign="top">Problem &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9821 E</td>
|
|
<td align="left" valign="top">Not authorized to program &1 in library &2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library &2
|
|
ended. Reason code &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA320 E</td>
|
|
<td align="left" valign="top">Pointer parameter is null.</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<hr>
|
|
API introduced: V3R1
|
|
|
|
<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 API list</a><br>
|
|
<a href=
|
|
"aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|