friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qpzlstgrpdtls.htm

1309 lines
38 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>List PTF Group Details(QpzListPtfGroupDetails) 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: -->
<!-- YYMMDD USERID Change description -->
<!-- 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>List PTF Group Details(QpzListPtfGroupDetails) 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%">Qualified user space name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">CHAR(20)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">PTF group information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CCSID for returned information</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 List PTF Group Details (QpzListPtfGroupDetails) API lists information
for a specific PTF group on the system. The information returned is determined
by the format specified.</p>
<br>
<h3><a name="HDRPZRTVGRP_2">Authorities and Locks</a></h3>
<dl>
<dt><em>Work with PTF Groups (WRKPTFGRP) command</em></dt>
<dd>*USE<br>
<br>
</dd>
<dt><em>User Space Authority</em></dt>
<dd>*CHANGE<br>
<br>
</dd>
<dt><em>User Space Library Authority</em></dt>
<dd>*EXECUTE<br>
<br>
</dd>
<dt><em>User Space Lock</em></dt>
<dd>*EXCLRD</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="HDRPZRTVGRP_3">Required Parameter Group</a></h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user space that is to receive the generated list. The first 10
characters contain the user space name. The second 10 characters contain the
name of the library where the user space is located. You can use these special
values for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The job's current library.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>PTF group information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The attributes of the PTF group for which information is being requested.
For more information on this parameter, see <a href="#HDRPZRTVGRP_INF">Format
of PTF group information</a>.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the information returned for this PTF group. The
possible format names are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>GRPR0100</em></td>
<td align="left" valign="top">Return basic information about the PTF group. All
information is returned in the user space Header Section, no list information
is returned for this format. For details, see <a href="#HDRPZRTVGRP_8">Header
Section</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>GRPR0200</em></td>
<td align="left" valign="top">Return basic information about the PTF group
including the list of PTFs named within the PTF group. For details, see <a
href="#HDRPZRTVGRP_R020">GRPR0200 Format List Section</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>GRPR0300</em></td>
<td align="left" valign="top">Return basic information about the PTF group
including the list of PTFs named within the PTF group and their detailed
information. For details, see <a href="#HDRPZRTVGRP_R030">GRPR0300 Format List
Section</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>GRPR0400</em></td>
<td align="left" valign="top">Return the same information as in GRPR0300
format, but for any PTFs that are superseded by a later PTF, return detailed
information about the superseded by PTF ID in place of the superseded PTF. For
details, see <a href="#HDRPZRTVGRP_R030">GRPR0300 Format List Section</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>GRPR0500</em></td>
<td align="left" valign="top">Return the list of related PTF groups. For
details, see <a href="#HDRPZRTVGRP_R050">GRPR0500 Format List Section</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>CCSID for returned information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The coded character set ID in which to return the PTF group name,
description, and related PTF group names. Valid values are 0 through 65533. If
a value of 0 is specified, the names and descriptions will be returned 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="HDRPZRTVGRP_INF">Format of PTF group information</a></h3>
<p>For the detailed descriptions of each field, see the <a href=
"#HDRPZRTVGRP_FDI">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="BOTTOM">Dec</th>
<th align="center" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">BINARY(4)</td>
<td align="LEFT" valign="TOP" width="60%">Length of PTF group information</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">CHAR(60)</td>
<td align="LEFT" valign="TOP">PTF group name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">64</td>
<td align="CENTER" valign="TOP">40</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">CCSID of PTF group name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">68</td>
<td align="CENTER" valign="TOP">44</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Include related PTF groups</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRPZRTVGRP_FDI">Field Descriptions</a></h3>
<p><strong>CCSID of PTF group name.</strong> The coded character set ID for the
PTF group name specified in the PTF group information parameter. 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>
<p><strong>Include related PTF groups.</strong> Whether to include information
from all related PTF groups in the returned list information. The following
values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not include information from related PTF
groups. For formats GRPR0200, GRPR0300, and GRPR0400, only the information for
the PTFs named within this PTF group is returned. For format GRPR0500, only the
related PTF groups named within this PTF group are returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Include all information from all related PTF
groups. For formats GRPR0200, GRPR0300, and GRPR0400, the information for all
PTFs named within this PTF group and all related PTF groups is returned. For
format GRPR0500, the related PTF groups in all related PTF groups are
returned.</td>
</tr>
</table>
<p><strong>Length of PTF group information.</strong> The length of the data in
the PTF group information parameter, including this field. The only valid value
for this field is 69.</p>
<p><strong>PTF group name.</strong> The name of the PTF group for which
information is being requested. The name is limited to a maximum of 30
characters.</p>
<br>
<h3><a name="HDRPZRTVGRP_6">Format of the Generated Lists</a></h3>
<p>The user space will contain:</p>
<ul>
<li>A user area</li>
<li>A generic header</li>
<li>An input parameter section</li>
<li>A header section</li>
<li>A list data section:
<ul>
<li>GRPR0200 format</li>
<li>GRPR0300 format</li>
<li>GRPR0400 format</li>
<li>GRPR0500 format</li>
</ul>
</li>
</ul>
<p>For details about the user area and generic header, see <a href=
"../apiref/usf.htm">User Space Format for List APIs</a>. For details about the remaining
items, see the following sections. For detailed descriptions of the fields in
the generated list returned, see <a href="#HDRPZRTVGRP_FD">Field
Descriptions</a>.</p>
<p>When you retrieve the list entry information from a user space, you must use
the entry size returned in the generic header. The size of each entry may be
padded at the end. If you do not use the entry size, the result may not be
valid. For examples of how to process lists, see <a href="../apiref/apiexmp.htm">API
examples</a>.</p>
<br>
<h4><a name="HDRPZRTVGRP_IP">Input Parameter Section</a></h4>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="BOTTOM">Dec</th>
<th align="center" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(10)</td>
<td align="LEFT" valign="TOP" width="60%">User space name specified</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">10</td>
<td align="CENTER" valign="TOP">A</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">User space library name specified</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">20</td>
<td align="CENTER" valign="TOP">14</td>
<td align="LEFT" valign="TOP">CHAR(60)</td>
<td align="LEFT" valign="TOP">PTF group name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">80</td>
<td align="CENTER" valign="TOP">50</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Format name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">88</td>
<td align="CENTER" valign="TOP">58</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">CCSID of PTF group name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">92</td>
<td align="CENTER" valign="TOP">5C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">CCSID for returned information</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">96</td>
<td align="CENTER" valign="TOP">60</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Include related PTF groups</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRPZRTVGRP_8">Header Section</a></h4>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="BOTTOM">Dec</th>
<th align="center" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(10)</td>
<td align="LEFT" valign="TOP" width="60%">User space name used</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">10</td>
<td align="CENTER" valign="TOP">A</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">User space library name used</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">20</td>
<td align="CENTER" valign="TOP">14</td>
<td align="LEFT" valign="TOP">CHAR(60)</td>
<td align="LEFT" valign="TOP">PTF group name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">80</td>
<td align="CENTER" valign="TOP">50</td>
<td align="LEFT" valign="TOP">CHAR(100)</td>
<td align="LEFT" valign="TOP">PTF group description</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">180</td>
<td align="CENTER" valign="TOP">B4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">PTF group level</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">184</td>
<td align="CENTER" valign="TOP">B8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">PTF group status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">188</td>
<td align="CENTER" valign="TOP">BC</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Date of special handling PTFs</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRPZRTVGRP_R020">GRPR0200 Format List Section</a></h4>
<br>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="BOTTOM">Dec</th>
<th align="center" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(7)</td>
<td align="LEFT" valign="TOP" width="60%">PTF ID</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">7</td>
<td align="CENTER" valign="TOP">7</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Product ID</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">14</td>
<td align="CENTER" valign="TOP">E</td>
<td align="LEFT" valign="TOP">CHAR(6)</td>
<td align="LEFT" valign="TOP">Release</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">20</td>
<td align="CENTER" valign="TOP">14</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Product option</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Product load ID</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">CHAR(2)</td>
<td align="LEFT" valign="TOP">Minimum level</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">30</td>
<td align="CENTER" valign="TOP">1E</td>
<td align="LEFT" valign="TOP">CHAR(2)</td>
<td align="LEFT" valign="TOP">Maximum level</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRPZRTVGRP_R030">GRPR0300 Format List Section</a></h4>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="BOTTOM">Dec</th>
<th align="center" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(7)</td>
<td align="LEFT" valign="TOP" width="60%">PTF ID</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">7</td>
<td align="CENTER" valign="TOP">7</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Product ID</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">14</td>
<td align="CENTER" valign="TOP">E</td>
<td align="LEFT" valign="TOP">CHAR(6)</td>
<td align="LEFT" valign="TOP">Release</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">20</td>
<td align="CENTER" valign="TOP">14</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Product option</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Product load ID</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">CHAR(2)</td>
<td align="LEFT" valign="TOP">Minimum level</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">30</td>
<td align="CENTER" valign="TOP">1E</td>
<td align="LEFT" valign="TOP">CHAR(2)</td>
<td align="LEFT" valign="TOP">Maximum level</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">32</td>
<td align="CENTER" valign="TOP">20</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Loaded status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">33</td>
<td align="CENTER" valign="TOP">21</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">IPL action</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">34</td>
<td align="CENTER" valign="TOP">22</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Action pending</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">35</td>
<td align="CENTER" valign="TOP">23</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Action required</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">36</td>
<td align="CENTER" valign="TOP">24</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Cover letter status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">37</td>
<td align="CENTER" valign="TOP">25</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">On-order status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">38</td>
<td align="CENTER" valign="TOP">26</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Save file status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">39</td>
<td align="CENTER" valign="TOP">27</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Save file name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">49</td>
<td align="CENTER" valign="TOP">31</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Save file library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">59</td>
<td align="CENTER" valign="TOP">3B</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Superseded by PTF ID</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">66</td>
<td align="CENTER" valign="TOP">42</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Latest superseding PTF ID</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">73</td>
<td align="CENTER" valign="TOP">49</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Product status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">74</td>
<td align="CENTER" valign="TOP">4A</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Omit status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">75</td>
<td align="CENTER" valign="TOP">4B</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Pre-apply status</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRPZRTVGRP_R050">GRPR0500 Format List Section</a></h4>
<br>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="BOTTOM">Dec</th>
<th align="center" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(60)</td>
<td align="LEFT" valign="TOP" width="60%">Related PTF group name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">60</td>
<td align="CENTER" valign="TOP">3C</td>
<td align="LEFT" valign="TOP">CHAR(100)</td>
<td align="LEFT" valign="TOP">PTF group description</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">160</td>
<td align="CENTER" valign="TOP">A0</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">PTF group level</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">164</td>
<td align="CENTER" valign="TOP">A4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">PTF group status</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRPZRTVGRP_FD">Field Descriptions</a></h3>
<p><strong>Action pending.</strong> Indicates whether a required action has yet
to be performed to make this PTF active. This field reflects the current status
of any required actions. The following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No required actions are pending for this
PTF.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A required action needs to occur for this PTF to
be active. Check the Activation Instructions section of the cover letter to
determine what the action is.
<p>If the action required field is 2 and you have performed the activation
instructions, then the PTF is active. However, this field will not be updated
until the next IPL.</p>
</td>
</tr>
</table>
<p><strong>Action required.</strong> An action is required to make this PTF
active when it is applied. See the cover letter to determine what action needs
to be taken. The following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No activation instructions are needed for this
PTF.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This PTF was shipped with activation instructions
in the cover letter. This value is returned for all PTFs that have an exit
program to update the status of the PTF after the activation instructions have
been performed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">This PTF was shipped with activation instructions
in the cover letter. No exit program exists to verify the activation
instructions were performed.</td>
</tr>
</table>
<p><strong>Cover letter status.</strong> Whether a cover letter exists for the
PTF. The following values are valid.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em> </td>
<td align="left" valign="top">The PTF has no cover letter.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF has a cover letter.</td>
</tr>
</table>
<p><strong>Date of special handling PTFs.</strong> The date the PTF group was last created with special handling PTFs. The date is specified in format yyyymmdd. The following special value is valid:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No date provided. </td>
</tr>
</table>
<p><strong>IPL action.</strong> The action to be taken on this PTF during the
next IPL. The following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No action occurs at the next IPL.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF is temporarily applied at the next
IPL.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The PTF is temporarily removed at the next
IPL.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The PTF is permanently applied at the next
IPL.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">The PTF is permanently removed at the next
IPL.</td>
</tr>
</table>
<p><strong>Latest superseding PTF ID.</strong> The identifier of the most
recent supersede of this PTF that exists on the system. This field will be
blank when the PTF does not have a superseding PTF.</p>
<p><strong>Loaded status.</strong> The current loaded status of the PTF. The
following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF has never been loaded.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF is loaded.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The PTF is applied temporarily.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The PTF is applied permanently.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">The PTF is permanently removed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">The PTF is damaged. An error occurred while
applying the PTF. It needs to be reloaded and applied.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">The PTF is superseded. A PTF will have a status
of superseded when one of the following situations occurs:
<ul compact>
<li>Another PTF with a more recent correction for the problem has been loaded
on the system. The identifier of the PTF that has been loaded can be found in
the superseded by PTF ID field.</li>
<li>The PTF save file for another PTF with a more recent correction for the
problem has been logged into *SERVICE on the system. The most recent PTF ID
with a PTF save file that has been logged into *SERVICE can be found in the
latest superseding PTF field.</li>
</ul>
</td>
</tr>
</table>
<p><strong>Library name.</strong> The name of the library where the user space
can be located. You can use these special values for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The job's current library.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list.</td>
</tr>
</table>
<p><strong>Maximum level.</strong> The indicator of the highest level of the
product on which this PTF can be installed. If the minimum and maximum levels
are the same, then this PTF can only be installed on one level of the product.
The level can be AA to 99. This field will be blank if the product has no
level.</p>
<p><strong>Minimum level.</strong> The indicator of the lowest level of the
product on which this PTF can be installed. If the minimum and maximum levels
are the same, then this PTF can only be installed on one level of the product.
The level can be AA to 99. This field will be blank if the product has no
level.</p>
<p><strong>Omit status.</strong> Whether the PTF should be omitted when installing the PTF group. The
following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF should not be omitted.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF was defined to be omitted when the PTF group was created.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The PTF was specified to be omitted by the user when the PTF group was installed.</td>
</tr>
</table>
<p><strong>On-order status.</strong> Whether the PTF has been ordered. The
following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF has not been ordered or has already been
received.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF has been ordered.</td>
</tr>
</table>
<p><strong>Pre-apply status.</strong> Whether the PTF should be applied before the other PTFs when installing the PTF group. The
following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF should not be pre-applied.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF should be applied temporarily before the other PTFs when installing the PTF group.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The PTF should be applied permanently before the other PTFs when installing the PTF group.</td>
</tr>
</table>
<p><strong>Product ID.</strong> The product identifier of the PTF.</p>
<p><strong>Product load ID.</strong> The load ID of the product load for the
PTF. A value of "CODE" indicates this PTF is for the code load of the
product.</p>
<p><strong>Product option.</strong> The option of the product for the PTF.</p>
<p><strong>Product status.</strong> The current status of the product. The
following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF is for a product, version, option, load
identifier, and level that is not installed or supported on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF is for a product, version, option, load
identifier, and level that is installed on the system. The product may or may
not be supported.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The PTF is for a product, version, option, and
load identifier, that is only supported on the system, it is not
installed.</td>
</tr>
</table>
<p><strong>PTF group description.</strong> The text description of the PTF
group.</p>
<p><strong>PTF group level.</strong> The level of the PTF group. A value of 0
indicates the PTF group level cannot be determined.</p>
<p><strong>PTF group name.</strong> The name of the PTF group for which
information is being requested.</p>
<p><strong>PTF group status.</strong> The overall status of the PTF group on
this system. The PTF group status is obtained using the status of all the PTFs
listed within the PTF group as well as all PTFs listed in all related PTF
groups. The following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em> </td>
<td align="left" valign="top">Unknown. The PTF group status cannot be resolved
because a related PTF group is either not found on the system or is in
error.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em> </td>
<td align="left" valign="top">Not applicable. All PTFs in the PTF group and
related PTF groups are for products that are not installed or supported on this
system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em> </td>
<td align="left" valign="top">Supported only. There are no PTFs in the PTF
group or related PTF groups that are for installed products on this system.
There is at least one PTF that is for a product, release, option, and load
identifier that is supported on this system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em> </td>
<td align="left" valign="top">Not installed. There is at least one PTF that is
for an installed product on this system, and not all of the PTFs or their
superseding PTFs are temporarily or permanently applied.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em> </td>
<td align="left" valign="top">Installed. All PTFs for products that are
installed on this system are temporarily or permanently applied. If a PTF is
superseded, a superseding PTF is either temporarily or permanently
applied.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em> </td>
<td align="left" valign="top">Error. The PTF group information is in error.
Either delete the PTF group or replace the PTF group information that is
currently on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em> </td>
<td align="left" valign="top">Not found. The PTF group is not found on the
system. This status will only be returned for the status of a related PTF group
when using format GRPR0500.</td>
</tr>
</table>
<p><strong>PTF ID.</strong> The identifier of the PTF in the PTF group.</p>
<p><strong>Related PTF group name.</strong> The name of the related PTF
group.</p>
<p><strong>Release.</strong> The version, release, and modification of the
product in the format V<em>x</em>R<em>y</em>M<em>z</em>. Valid values for
<em>x</em> and <em>y</em> are 0 through 9, and valid values for <em>z</em> are
0 through 9 or A through Z.</p>
<p><strong>Save file library name.</strong> The name of the library where the
save file for the PTF is located. If no save file name has been reserved, this
field will be blank.</p>
<p><strong>Save file name.</strong> The name of the file where the save file
for the PTF is located. You should use the save file status field to determine
if a save file exists for this PTF. If no save file name have been reserved,
this field will be blank.</p>
<p><strong>Save file status.</strong> Whether a save file exists on the system
for the PTF. The following values are valid.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF has no save file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF has a save file.</td>
</tr>
</table>
<p><strong>Superseded by PTF ID.</strong> The identifier of the PTF that has
replaced this PTF. This field will be blank when the PTF is not superseded or
when the superseding PTF has not been loaded on the system.</p>
<p><strong>User space library name specified.</strong> The name specified for
the library that contains the user space to receive the generated list.</p>
<p><strong>User space library name used.</strong> The actual name of the
library that is used to contain the user space that received the list.</p>
<p><strong>User space name specified.</strong> The name specified for the user
space that is to receive the generated list.</p>
<p><strong>User space name used.</strong> The actual name of the user space
that received the list.</p>
<br>
<h3><a name="HDRPZRTVGRP_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 width="15%" valign="top">CPF0CEE E</td>
<td width="85%" valign="top">Unable to convert data to CCSID &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</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">CPF36A5 E</td>
<td align="left" valign="top">Information for PTF group &amp;1 not
complete.</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">CPF36B1 E</td>
<td align="left" valign="top">Value for parameter &amp;1 not valid.</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">CPF3C1D E</td>
<td align="left" valign="top">Length specified in parameter &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CAA E</td>
<td align="left" valign="top">List is too large for user space &amp;1.</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 &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in libary
&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9838 E</td>
<td align="left" valign="top">User profile storage limit exceeded.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
<p>API introduced: V5R2</p>
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<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>
</body>
</html>
Reference in New Issue Copy Permalink