514 lines
14 KiB
HTML
514 lines
14 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>List PTF Groups (QpzListPtfGroups) 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 Groups (QpzListPtfGroups) 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%">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">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">3</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">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>
|
||
|
Service Program Name: QPZGROUP<br>
|
||
|
<!-- iddvc RMBR -->
|
||
|
<br>
|
||
|
Default Public Authority: *USE<br>
|
||
|
<!-- iddvc RMBR -->
|
||
|
<br>
|
||
|
Threadsafe: No<br>
|
||
|
<!-- iddvc RMBR -->
|
||
|
<br>
|
||
|
</div>
|
||
|
|
||
|
<p>The List PTF Groups (QpzListPtfGroups) API returns a list of all PTF groups
|
||
|
that are known to the system. You can then use the QpzListPtfGroupDetails API
|
||
|
to return detailed information for a specific PTF group.</p>
|
||
|
|
||
|
<br>
|
||
|
<h3><a name="HDRPZLSTGRP_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="HDRPZLSTGRP_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>Format name</strong></dt>
|
||
|
|
||
|
<dd>INPUT; CHAR(8)
|
||
|
|
||
|
<p>The content and format of the information that is returned. The possible
|
||
|
format names are:</p>
|
||
|
|
||
|
<table cellpadding="5">
|
||
|
<!-- cols="15 85" -->
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>LSTG0100</em></td>
|
||
|
<td align="left" valign="top">List of PTF group names, levels, descriptions,
|
||
|
and status. For details, see <a href="#HDRPZLSTGRP_G010">LSTG0100 Format List
|
||
|
Section</a>.</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
|
||
|
<br>
|
||
|
</dd>
|
||
|
|
||
|
<dt><strong>CCSID</strong></dt>
|
||
|
|
||
|
<dd>INPUT; BINARY(4)
|
||
|
|
||
|
<p>The coded character set ID in which to return the PTF group names and
|
||
|
descriptions. 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="HDRPZLSTGRP_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>LSTG0100 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="#HDRPZLSTGRP_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>
|
||
|
<h3><a name="HDRPZLSTGRP_IPX">Input Parameter Section</a></h3>
|
||
|
|
||
|
<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(8)</td>
|
||
|
<td align="left" valign="top">Format name</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="CENTER" valign="top">28</td>
|
||
|
<td align="CENTER" valign="top">1A</td>
|
||
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
<td align="left" valign="top">CCSID</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
|
||
|
<br>
|
||
|
<br>
|
||
|
<h3><a name="HDRPZLSTGRP_8">Header Section</a></h3>
|
||
|
|
||
|
<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 library 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 name used</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
|
||
|
<br>
|
||
|
<br>
|
||
|
<h3><a name="HDRPZLSTGRP_G010">LSTG0100 Format List Section</a></h3>
|
||
|
|
||
|
<p>The following information is repeated for each PTF group.</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%">CHAR(60)</td>
|
||
|
<td align="left" valign="top" width="60%">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="HDRPZLSTGRP_FD">Field Descriptions</a></h3>
|
||
|
|
||
|
<p><strong>CCSID.</strong> The coded character set ID of the returned PTF group
|
||
|
names and descriptions that was requested.</p>
|
||
|
|
||
|
<p><strong>Format name.</strong> The format of the returned information that
|
||
|
was requested.</p>
|
||
|
|
||
|
<p><strong>PTF group description.</strong> The text description of the PTF
|
||
|
group.</p>
|
||
|
|
||
|
<p><strong>PTF group level.</strong> The current level of the PTF group.</p>
|
||
|
|
||
|
<p><strong>PTF group name.</strong> The name of the PTF group.</p>
|
||
|
|
||
|
<p><strong>PTF group status.</strong> The overall status of the PTF group on
|
||
|
this system. The following values are valid:</p>
|
||
|
|
||
|
<table cellpadding="5">
|
||
|
<!-- cols="15 85" -->
|
||
|
<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>
|
||
|
</table>
|
||
|
|
||
|
<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="HDRPZLSTGRP_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 &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">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 &1 outside of valid range.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top">CPF3CAA E</td>
|
||
|
<td align="left" valign="top">List is too large for user space &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 &1
|
||
|
API.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top">CPF3C21 E</td>
|
||
|
<td align="left" valign="top">Format name &1 is not valid.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top">CPF9801 E</td>
|
||
|
<td align="left" valign="top">Object &2 in library &3 not found.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top">CPF9802 E</td>
|
||
|
<td align="left" valign="top">Not authorized to object &2 in &3.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top">CPF9803 E</td>
|
||
|
<td align="left" valign="top">Cannot allocate object &2 in libary
|
||
|
&3.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top">CPF9820 E</td>
|
||
|
<td align="left" valign="top">Not authorized to use library &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 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>
|
||
|
</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>
|
||
|
|