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

270 lines
6.9 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 PTF Group (QpzDeletePtfGroup) 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. -->
<!-- Created for V5R2 by (Ron Haugen) -->
<!-- Change history -->
<!-- Edited by Kersten Jan 02 -->
<!--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>Delete PTF Group (QpzDeletePtfGroup) API</h2>
<div class="box" style="width: 80%;">
<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%">PTF group name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">CHAR(60)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">PTF group level</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">BINARY(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Delete related PTF groups</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CCSID</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">BINARY(4)</td>
</tr>
<tr>
<td align="center" valign="top">5</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;Service Program Name: QPZGROUP<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Delete PTF Group (QpzDeletePtfGroup) API deletes a PTF group from the
system. You can optionally delete all related PTF groups at the same time.</p>
<br>
<h3><a name="HDRPZDLTGRP_2">Authorities and Locks</a></h3>
<dl>
<dt><em>Work with PTF Groups (WRKPTFGRP) command</em></dt>
<dd>*USE</dd>
</dl>
<p>Lock conflicts may occur if this API is called while another PTF or PTF
group operation is in progress.</p>
<br>
<h3><a name="HDRPZDLTGRP_3">Required Parameter Group</a></h3>
<dl>
<dt><strong>PTF group name</strong></dt>
<dd>INPUT; CHAR(60)
<p>The name or generic name of the PTF group to be deleted. A generic name is a
string of one or more characters followed by an asterisk (*). You can use these
special values for the PTF group name:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All PTF groups on the system are deleted.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>PTF group level</strong></dt>
<dd>INPUT; BINARY(4)
<p>The level of the PTF group to be deleted. This parameter is ignored when a
generic name or *ALL is specified for the PTF group name. Valid values for this
parameter are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The current level of the PTF group is
deleted.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>1 - 99999</em></td>
<td align="left" valign="top">The specified level of the PTF group is deleted.
If the level does not exist on the system, an error will occur.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Delete related PTF groups</strong></dt>
<dd>INPUT; CHAR(1)
<p>Whether related PTF groups will be deleted at the time this PTF group is
deleted. This parameter is ignored when *ALL is specified for the PTF group
name. Valid values for this parameter are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Related PTF groups will not be deleted.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Related PTF groups will be deleted when this PTF
group is deleted. This will also delete the related PTF groups of the related
PTF groups.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>CCSID</strong></dt>
<dd>INPUT; BINARY(4)
<p>The coded character set ID for the PTF group name. Valid values are 0
through 65533. If a value of 0 is specified, the name is assumed to be in the
CCSID of the 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="HDRPZDLTGRP_9">Error Messages</a></h3>
<table width="100%" cellpadding="5">
<!-- 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">CPF0CEE E</td>
<td align="left" valign="top">Unable to convert data to CCSID &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36A2 E</td>
<td align="left" valign="top">Length of PTF group name or text too long.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36A4 E</td>
<td align="left" valign="top">PTF group &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36A6 E</td>
<td align="left" valign="top">PTF group name &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36AF E</td>
<td align="left" valign="top">PTF group function already in progress.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3BC7 E</td>
<td align="left" valign="top">CCSID &amp;1 outside of valid range.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C3C E</td>
<td align="left" valign="top">Value for parameter &amp;1 not valid.</td>
</tr>
<tr>
<td width="15%" 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 &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API 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=
"sw1.htm">Software Product APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table></center>
</body>
</html>