1007 lines
29 KiB
HTML
1007 lines
29 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>Select Product (QSZSLTPR) 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. -->
|
||
|
|
<!-- QSZSLTPR SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
|
||
|
|
<!-- at RCHVMW2 on 7 Oct 1998 at 20:36:19 -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- 050914 roch Change System Manager product title -->
|
||
|
|
<!-- 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>Select Product (QSZSLTPR) 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%">Output List</td>
|
||
|
|
<td align="left" valign="top" width="20%">Output</td>
|
||
|
|
<td align="left" valign="top" width="20%">Array of Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Input information</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(40)</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">Input list</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Array of Char(18)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">Output information</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(12)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</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>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Select Product (QSZSLTPR) API displays a list of products. One or more
|
||
|
|
products can then be selected from the prompt screen. The list of selected
|
||
|
|
products is then returned to the caller of the API. The list of products
|
||
|
|
displayed can be:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>All installed products.</li>
|
||
|
|
|
||
|
|
<li>All supported products.</li>
|
||
|
|
|
||
|
|
<li>All defined products.</li>
|
||
|
|
|
||
|
|
<li>A user-specified subset of all defined products.</li>
|
||
|
|
|
||
|
|
<li>All products that are supported, installed, or both installed and
|
||
|
|
supported.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>Alternatively, the QSZSLTPR API can return a list of products without
|
||
|
|
displaying a list of products. The result is as if the list of products had
|
||
|
|
been displayed and all products in the list had been selected.</p>
|
||
|
|
|
||
|
|
<p>If the job is in batch mode, the number of products to select field must be
|
||
|
|
*ALL.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> A product can be supported and unsupported by using
|
||
|
|
the Work with Supported Products (WRKSPTPRD) command. This command is part of
|
||
|
|
the System Manager for i5/OS licensed program.</p>
|
||
|
|
|
||
|
|
<p>A defined product is one which is known to the system. This includes all
|
||
|
|
installed products, but also includes products which are known to the system
|
||
|
|
without the products being installed. For example, V5R4M0 of the System Manager
|
||
|
|
for i5/OS licensed program (5722SM1) is known to the system once V5R4M0 of the
|
||
|
|
operating system is installed. Therefore V5R4M0 of 5722SM1 is a defined product
|
||
|
|
once V5R4M0 of the operating system is installed.</p>
|
||
|
|
|
||
|
|
<p>A product is also a defined product when a product definition (*PRDDFN)
|
||
|
|
object exists for that product on the system.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>*PRDAVL Lock</em></dt>
|
||
|
|
|
||
|
|
<dd>*SHRRD</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Output list</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; Array of CHAR(*)
|
||
|
|
|
||
|
|
<p>An array where you will receive one or more product records.</p>
|
||
|
|
|
||
|
|
<p>All the records of this array will have the same size. The size is returned
|
||
|
|
in the record size field of the output information parameter.</p>
|
||
|
|
|
||
|
|
<p>When the number of products to select field of the input information
|
||
|
|
parameter is:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ONE</em></td>
|
||
|
|
<td align="left" valign="top">The output array must be able to contain at least
|
||
|
|
one record or the results are unpredictable.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">The array contains a complete list of product ID
|
||
|
|
records as if all product IDs were selected. No display is shown. If you do not
|
||
|
|
provide enough space for all the records, as many records as can be returned in
|
||
|
|
the space provided will be returned. The Records available field of the Output
|
||
|
|
information parameter will indicate the number of records that were available
|
||
|
|
to be returned.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ANY</em></td>
|
||
|
|
<td align="left" valign="top">The array contains a list of product ID records
|
||
|
|
selected from the display. It is assumed that you can select all of the product
|
||
|
|
IDs shown on the display. Therefore, the output array has to be able to hold
|
||
|
|
all the records shown on the display. This is checked before the display is
|
||
|
|
shown. If the output array cannot hold all of the available records, an error
|
||
|
|
message is returned and no display is shown.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>For information about the layout of this parameter, see <a href=
|
||
|
|
"#HDRPRDS100">PRDS0100 Format</a> and <a href="#HDRPRDS200">PRDS0200
|
||
|
|
Format</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Input information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(40)
|
||
|
|
|
||
|
|
<p>Specifies:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The number of records to be returned.</li>
|
||
|
|
|
||
|
|
<li>Whether a list of products is to be displayed for selection or whether no
|
||
|
|
list is to be displayed.</li>
|
||
|
|
|
||
|
|
<li>Several attributes of the display if the list is to be displayed for
|
||
|
|
selection.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>See <a href="#HDRINPTINF">Input Information Format</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The content and format of the information returned.</p>
|
||
|
|
|
||
|
|
<p>The possible format names are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>PRDS0100</em></td>
|
||
|
|
<td align="left" valign="top">Basic information is returned. See <a href=
|
||
|
|
"#HDRPRDS100">PRDS0100 Format</a>.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>PRDS0200</em></td>
|
||
|
|
<td align="left" valign="top">This format includes more information than format
|
||
|
|
PRDS0100. See <a href="#HDRPRDS200">PRDS0200 Format</a>.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Input list</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; Array of CHAR(18)
|
||
|
|
|
||
|
|
<p>An array containing the records used to determine which products that are
|
||
|
|
defined to the system are displayed or returned. The Input list is ignored
|
||
|
|
unless the Product field is equal to *LIST. The format of the data for the
|
||
|
|
input list is described in <a href="#HDRINLSTP">Input List Format</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Output information</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(12)
|
||
|
|
|
||
|
|
<p>The following information is returned:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The size of an output record.</li>
|
||
|
|
|
||
|
|
<li>The number of records available.</li>
|
||
|
|
|
||
|
|
<li>An indicator of what action was performed on the display.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>See <a href="#HDROUTPINF">Output information Format</a>.</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="HDRINPTINF">Input Information Format</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%">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Number of records to return</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Number of products to select</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">14</td>
|
||
|
|
<td align="center" valign="top">E</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Initial panel view</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">15</td>
|
||
|
|
<td align="center" valign="top">F</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Allow exit</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">16</td>
|
||
|
|
<td align="center" valign="top">10</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Product options to display</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">26</td>
|
||
|
|
<td align="center" valign="top">1A</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Product</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">36</td>
|
||
|
|
<td align="center" valign="top">24</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Records in list</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="HDRINPTIFD">Field Descriptions for Input Information</a></h4>
|
||
|
|
|
||
|
|
<p>When *LIST is specified for Product, then a list of product records must be
|
||
|
|
specified for the Input List parameter.</p>
|
||
|
|
|
||
|
|
<p><strong>Allow exit.</strong> Whether the exit action is allowed from the
|
||
|
|
display.</p>
|
||
|
|
|
||
|
|
<p>The valid values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Exit and cancel are both allowed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Only cancel is allowed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Initial panel view.</strong> Whether the first view of the display
|
||
|
|
shows the release level.</p>
|
||
|
|
|
||
|
|
<p>If the release level is shown on the first view, the description is not
|
||
|
|
shown until the view is changed by pressing the appropriate key. If the first
|
||
|
|
view does not show the release level, the appropriate key can be pressed to
|
||
|
|
change the view and show the release level.</p>
|
||
|
|
|
||
|
|
<p>The valid values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The initial view of the display shows the release
|
||
|
|
level.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">The initial view of the display shows the
|
||
|
|
description text.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Number of products to select.</strong> The number of products that
|
||
|
|
are allowed to be selected on the display. This field controls whether a panel
|
||
|
|
is displayed or not.</p>
|
||
|
|
|
||
|
|
<p>The valid values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ONE</em></td>
|
||
|
|
<td align="left" valign="top">One product is allowed to be selected. If the job
|
||
|
|
is in batch mode, CPF0C1A will be returned.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ANY</em></td>
|
||
|
|
<td align="left" valign="top">Any number of products can be selected. If the
|
||
|
|
job is in batch mode, CPF0C1A will be returned.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">No list is displayed; all the products will be
|
||
|
|
selected.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Number of records to return.</strong> The number of records that can
|
||
|
|
be put in the output list array.</p>
|
||
|
|
|
||
|
|
<p><strong>Product.</strong> If the Number of products to select parameter is
|
||
|
|
*ALL, this field specifies which products to return. Otherwise, this field
|
||
|
|
specifies which products to put in the list of products to display.</p>
|
||
|
|
|
||
|
|
<p>The valid values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*INSTLD</em></td>
|
||
|
|
<td align="left" valign="top">Installed products. Installed means that a
|
||
|
|
product definition (*PRDDFN) object and a product load (*PRDLOD) object for the
|
||
|
|
code load were loaded onto the system by the Restore Licensed Program
|
||
|
|
(RSTLICPGM) command.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*SUPPTD</em></td>
|
||
|
|
<td align="left" valign="top">Supported products. Products supported by using
|
||
|
|
the Work with Supported Products (WRKSPTPRD) command which is part of the
|
||
|
|
System Manager for i5/OS licensed program.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*INSSPT</em></td>
|
||
|
|
<td align="left" valign="top">Installed or supported products. All products
|
||
|
|
that are installed, supported, or both installed and supported.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">All known and defined products. This includes
|
||
|
|
installed and supported and others that are not installed or supported.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*LIST</em></td>
|
||
|
|
<td align="left" valign="top">The list of products shown on the display or
|
||
|
|
returned is derived from the list that is passed in the Input List array. The
|
||
|
|
API builds a list of product ID, product option, release level combinations
|
||
|
|
from the Input List parameter. See <a href="#HDRINPUTFD">Field Descriptions for
|
||
|
|
Input List</a> for information.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Product options to display.</strong> Whether only the base option of
|
||
|
|
each product is to be displayed or whether all options are to be displayed.</p>
|
||
|
|
|
||
|
|
<p>The valid values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">Show all options of a product</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*BASE</em></td>
|
||
|
|
<td align="left" valign="top">Show only the base option of a product</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Records in list.</strong> The number of records in the Input List
|
||
|
|
array. This is used only when the Product field is equal to *LIST.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3><a name="HDROUTPINF">Output information Format</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%">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Record size</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Records available</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Action</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="HDROUTPIFD">Field Descriptions for Output Information</a></h4>
|
||
|
|
|
||
|
|
<p><strong>Action.</strong> What action was performed on the display. If no
|
||
|
|
display was shown, 0 is returned.</p>
|
||
|
|
|
||
|
|
<p>The possible values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" nowrap><em>-4</em></td>
|
||
|
|
<td align="left" valign="top">Exit</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>-8</em></td>
|
||
|
|
<td align="left" valign="top">Cancel</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Enter</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>21</em></td>
|
||
|
|
<td align="left" valign="top">Select all</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Records available.</strong> The number of records that are available
|
||
|
|
to be returned.</p>
|
||
|
|
|
||
|
|
<p>If a panel is displayed and either the exit or cancel action is performed,
|
||
|
|
(so no records were selected) this number is 0.</p>
|
||
|
|
|
||
|
|
<p>If no records are shown on the display, or no records are returned in the
|
||
|
|
output array, this number will be equal to minus 1.</p>
|
||
|
|
|
||
|
|
<p>*ANY may be specified for the Number of products to select parameter. If so,
|
||
|
|
in case of an error, this number indicates the necessary size of the output
|
||
|
|
array. More storage is required for the API and no list is returned.</p>
|
||
|
|
|
||
|
|
<p>*ALL may be specified for the Number of products to select parameter. If so,
|
||
|
|
this number indicates whether there were more records to return in the output
|
||
|
|
array; a partial list may have been returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Record size.</strong> The length of the records of the output
|
||
|
|
array.</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>When format PRDS0100 is requested, this value is 83.</li>
|
||
|
|
|
||
|
|
<li>When format PRDS0200 is requested, this value is 197.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Input list and Output list Formats</h3>
|
||
|
|
|
||
|
|
<p>The output list parameter can be in one of two formats. See <a href=
|
||
|
|
"#HDRPRDS100">PRDS0100 Format</a>, and <a href="#HDRPRDS200">PRDS0200
|
||
|
|
Format</a> for information.</p>
|
||
|
|
|
||
|
|
<h4><a name="HDRINLSTP">Input List Format</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%">Product ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="left" valign="top">CHAR(5)</td>
|
||
|
|
<td align="left" valign="top">Product option</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="center" valign="top">C</td>
|
||
|
|
<td align="left" valign="top">CHAR(6)</td>
|
||
|
|
<td align="left" valign="top">Release level</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="HDRINPUTFD">Field Descriptions for Input List</a></h4>
|
||
|
|
|
||
|
|
<p>When *LIST is specified for the Product parameter, then a list of product
|
||
|
|
records must be specified for the Input List parameter. The API builds a list
|
||
|
|
of product ID, product option, release level combinations from the Input List
|
||
|
|
parameter. All product ID, product option, release level combinations defined
|
||
|
|
to the system, which match a record in the Input List, are put into a list. The
|
||
|
|
list is displayed or returned.</p>
|
||
|
|
|
||
|
|
<p>Any combination of the product ID, product option, and release level fields
|
||
|
|
can be left blank. A blank field matches all values for that field. For
|
||
|
|
example, a product ID and product option are specified. But if the release
|
||
|
|
level field is left blank, all available releases of the specified product
|
||
|
|
option are displayed or returned.</p>
|
||
|
|
|
||
|
|
<p>If the Product ID, Product option, and Release level are all blank, all
|
||
|
|
available products at all release levels are displayed or returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Product ID.</strong> The product IDs to display or return. The
|
||
|
|
product ID must be a valid product ID for a defined product or blank. If the
|
||
|
|
API does not find a valid product ID from the defined products, an error is
|
||
|
|
returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Product option.</strong> The product option to display or return.
|
||
|
|
The product option must be blank or a valid product option must be specified.
|
||
|
|
Valid values are *BASE (00000), 00001, 00002, 00003, and so on. Leading zeros
|
||
|
|
are required.</p>
|
||
|
|
|
||
|
|
<p><strong>Release level.</strong> The release level of the product. The
|
||
|
|
release level must be either blank or in the format VxRxMy. Valid values for x
|
||
|
|
are 0 through 9. Valid values for y are 0 through 9 and A through Z.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="HDRPRDS100">PRDS0100 Format</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%">Product ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="left" valign="top">CHAR(5)</td>
|
||
|
|
<td align="left" valign="top">Product option</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="center" valign="top">C</td>
|
||
|
|
<td align="left" valign="top">CHAR(6)</td>
|
||
|
|
<td align="left" valign="top">Release level</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">18</td>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="left" valign="top">CHAR(2)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">20</td>
|
||
|
|
<td align="center" valign="top">14</td>
|
||
|
|
<td align="left" valign="top">CHAR(7)</td>
|
||
|
|
<td align="left" valign="top">Description text message ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">27</td>
|
||
|
|
<td align="center" valign="top">1B</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Description text object name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">37</td>
|
||
|
|
<td align="center" valign="top">25</td>
|
||
|
|
<td align="left" valign="top">CHAR(46)</td>
|
||
|
|
<td align="left" valign="top">Description text</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="HDRPRDS200">PRDS0200 Format</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%">Product ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="left" valign="top">CHAR(5)</td>
|
||
|
|
<td align="left" valign="top">Product option</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="center" valign="top">C</td>
|
||
|
|
<td align="left" valign="top">CHAR(6)</td>
|
||
|
|
<td align="left" valign="top">Release level</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">18</td>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="left" valign="top">CHAR(2)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">20</td>
|
||
|
|
<td align="center" valign="top">14</td>
|
||
|
|
<td align="left" valign="top">CHAR(7)</td>
|
||
|
|
<td align="left" valign="top">Description text message ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">27</td>
|
||
|
|
<td align="center" valign="top">1B</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Description text object name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">37</td>
|
||
|
|
<td align="center" valign="top">25</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Description text library name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">47</td>
|
||
|
|
<td align="center" valign="top">2F</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Installed flag</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">48</td>
|
||
|
|
<td align="center" valign="top">30</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Supported flag</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">49</td>
|
||
|
|
<td align="center" valign="top">31</td>
|
||
|
|
<td align="left" valign="top">CHAR(2)</td>
|
||
|
|
<td align="left" valign="top">Registration type</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">51</td>
|
||
|
|
<td align="center" valign="top">33</td>
|
||
|
|
<td align="left" valign="top">CHAR(14)</td>
|
||
|
|
<td align="left" valign="top">Registration value</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">65</td>
|
||
|
|
<td align="center" valign="top">41</td>
|
||
|
|
<td align="left" valign="top">CHAR(132)</td>
|
||
|
|
<td align="left" valign="top">Description text</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="HDROUTFD">Field Descriptions for output list</a></h4>
|
||
|
|
|
||
|
|
<p><strong>Description text.</strong> Text in the message that describes the
|
||
|
|
product option selected. To retrieve the message text, the library list is
|
||
|
|
searched for the specified message file. If the message file is not found, then
|
||
|
|
the description text library name is used to try to retrieve the message text.
|
||
|
|
If the message file is not found, blanks are returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> This field is only 46 characters long for format
|
||
|
|
PRDS0100 because product descriptions typically should not be longer than 46
|
||
|
|
characters. Product descriptions should not be longer than 46 characters
|
||
|
|
because some system commands display a maximum of 46 characters for each
|
||
|
|
product description.</p>
|
||
|
|
|
||
|
|
<p><strong>Description text library name.</strong> The name of the library for
|
||
|
|
the message file that contains the messages which describe the product and its
|
||
|
|
options.</p>
|
||
|
|
|
||
|
|
<p><strong>Description text message ID.</strong> A seven character alphanumeric
|
||
|
|
identifier assigned to the message that describes the product option selected.
|
||
|
|
The message ID for the base option is the message ID for the product.</p>
|
||
|
|
|
||
|
|
<p><strong>Description text object name.</strong> The name of the message file
|
||
|
|
that contains the messages which describe the product and its options.</p>
|
||
|
|
|
||
|
|
<p><strong>Installed flag.</strong> Whether the code load for this product
|
||
|
|
option is installed or not. A load is installed if a product load (*PRDLOD)
|
||
|
|
object is loaded on the system by the Restore Licensed Program (RSTLICPGM)
|
||
|
|
command.</p>
|
||
|
|
|
||
|
|
<p>The possible values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The code load is installed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">The code load is not installed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Product ID.</strong> The product ID selected.</p>
|
||
|
|
|
||
|
|
<p><strong>Product option.</strong> The product option of the product
|
||
|
|
selected.</p>
|
||
|
|
|
||
|
|
<p><strong>Registration type.</strong> The registration type associated with
|
||
|
|
the product. The registration type and registration value together make up the
|
||
|
|
registration ID for the product.</p>
|
||
|
|
|
||
|
|
<p><strong>Registration value.</strong> The registration value associated with
|
||
|
|
the product. The registration type and registration value together make up the
|
||
|
|
registration ID for the product.</p>
|
||
|
|
|
||
|
|
<p><strong>Release level.</strong> The release level of the product
|
||
|
|
selected.</p>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> This field will contain blanks.</p>
|
||
|
|
|
||
|
|
<p><strong>Supported flag.</strong> Whether this load is currently supported. A
|
||
|
|
load can be supported by using the Work with Supported Products (WRKSPTPRD)
|
||
|
|
command in the System Manager for i5/OS licensed program.</p>
|
||
|
|
|
||
|
|
<p>The possible values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The load is supported.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">The load is not supported.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRSLTERRM">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">CPF0C10 E</td>
|
||
|
|
<td width="85%" valign="top">Input information parameter at offset &3 is
|
||
|
|
not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0C11 E</td>
|
||
|
|
<td align="left" valign="top">Products listed in Input List array not
|
||
|
|
found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0C12 E</td>
|
||
|
|
<td align="left" valign="top">Output List array too small.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0C15 E</td>
|
||
|
|
<td align="left" valign="top">Error occurred while processing QSZSLTPR
|
||
|
|
API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0C1A E</td>
|
||
|
|
<td align="left" valign="top">Panel could not be displayed.</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">CPF3CF1 E</td>
|
||
|
|
<td align="left" valign="top">Error code parameter not valid.</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">CPF3C90 E</td>
|
||
|
|
<td align="left" valign="top">Literal value cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A00 E</td>
|
||
|
|
<td align="left" valign="top">All CPF6Axx messages could be returned. xx is
|
||
|
|
from 01 to FF.</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>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V3R1
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|