494 lines
13 KiB
HTML
494 lines
13 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>Add or Remove Product Support (QSZSPTPR) 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. -->
|
||
|
|
<!-- QSZSPTPR SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
|
||
|
|
<!-- at RCHVMW2 on 16 Nov 1998 at 14:41:30 -->
|
||
|
|
<!-- 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>Add or Remove Product Support (QSZSPTPR) 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%">Product information</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Length of product information</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Product information 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">Requested action</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>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Add or Remove Product Support (QSZSPTPR) API adds or removes support to
|
||
|
|
a product. The action is performed by specifying a product ID, release, option
|
||
|
|
number, and load ID. When you are adding support to a product, you indicate
|
||
|
|
that you want to be able to order and receive program temporary fixes (PTFs) to
|
||
|
|
maintain that product. An information entry is also created for that
|
||
|
|
product.</p>
|
||
|
|
|
||
|
|
<p>Removing product support does not remove related PTF save files or PTF
|
||
|
|
information. PTFs for products that are not supported, however, cannot be
|
||
|
|
distributed using the System Manager for i5/OS licensed program.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Product Availability Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>None<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Product Availability Lock</em></dt>
|
||
|
|
|
||
|
|
<dd>*SHRRD. The product availability object resides in the QUSRSYS library.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Product Definition Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>None<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Product Load Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>None</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Product information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The product for which support is to be added or removed. For the structure
|
||
|
|
of this parameter, see <a href="#HDRPVOLIN">Format of Product Information
|
||
|
|
Parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of product information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the product information parameter in bytes. The value
|
||
|
|
specified must be at least 53.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Product information format name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The content and format of the product information. The possible format name
|
||
|
|
is:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>SPTP0100</em></td>
|
||
|
|
<td align="left" valign="top">The product information needed to add or remove
|
||
|
|
support.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Requested action</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The action to be performed against each of the products in the list. 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">Adds support to the product passed in the first
|
||
|
|
parameter. When you use this value, you indicate that you want to provide
|
||
|
|
service support. If a product or product option contains information that is
|
||
|
|
translated to other languages, language support is automatically added for that
|
||
|
|
product or product option. The language supported is either the language for
|
||
|
|
the installed product or, if the product is not installed on this system, the
|
||
|
|
primary language that is installed for i5/OS on this system.<br>
|
||
|
|
<br>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Remove the current support information from the
|
||
|
|
system.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</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="HDRPVOLIN">Format of Product Information Parameter</a></h3>
|
||
|
|
|
||
|
|
<p>The following table shows the format of the product information parameter.
|
||
|
|
For a description of the fields in this format, see <a href="#HDRPVOLFD">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%">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(6)</td>
|
||
|
|
<td align="left" valign="top">Release</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">13</td>
|
||
|
|
<td align="center" valign="top">D</td>
|
||
|
|
<td align="left" valign="top">CHAR(4)</td>
|
||
|
|
<td align="left" valign="top">Product option</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">17</td>
|
||
|
|
<td align="center" valign="top">11</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Load 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">Library</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">37</td>
|
||
|
|
<td align="center" valign="top">25</td>
|
||
|
|
<td align="left" valign="top">CHAR(2)</td>
|
||
|
|
<td align="left" valign="top">Registration type</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">39</td>
|
||
|
|
<td align="center" valign="top">27</td>
|
||
|
|
<td align="left" valign="top">CHAR(14)</td>
|
||
|
|
<td align="left" valign="top">Registration value</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRPVOLFD">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<strong>Library.</strong>
|
||
|
|
<p>The name of the principal or main library of the product to be supported.
|
||
|
|
This value is optional. If support is being removed or no library is specified
|
||
|
|
when adding support, this field should contain blanks.</p>
|
||
|
|
|
||
|
|
<p><strong>Load ID.</strong> The load ID of the product for which support is
|
||
|
|
being added or removed. Load IDs are 4 characters in length; for example, 2924
|
||
|
|
is the load ID for an English national language version (NLV).</p>
|
||
|
|
|
||
|
|
<p>You can use this special value for the load ID:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*CODE</em></td>
|
||
|
|
<td align="left" valign="top">The load ID of the code load for the given
|
||
|
|
product ID, release, and option.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Product ID.</strong> The 7-character ID for the product for which
|
||
|
|
support is being added or removed.</p>
|
||
|
|
|
||
|
|
<p><strong>Product option.</strong> The option number of the product for which
|
||
|
|
support is being added or removed. Use 0000 for the base option. Valid values
|
||
|
|
are 0000 through 0099, where each character is a digit.</p>
|
||
|
|
|
||
|
|
<p><strong>Registration type.</strong> The registration type associated with
|
||
|
|
the product. This value is optional. If the registration type is not specified,
|
||
|
|
this field should contain blanks. Together, the registration type and
|
||
|
|
registration value make up the registration identifier for the product.</p>
|
||
|
|
|
||
|
|
<p>The possible values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>02</em></td>
|
||
|
|
<td align="left" valign="top">The registration containing a country or region code, city
|
||
|
|
code, and telephone number. All values are 14 characters. This value is the
|
||
|
|
same as specifying *PHONE as the registration type when a product load or
|
||
|
|
product definition is created.<br>
|
||
|
|
<br>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>04</em></td>
|
||
|
|
<td align="left" valign="top">The registration value is the same as the
|
||
|
|
registration value for i5/OS. The registration value field will be
|
||
|
|
ignored.<br>
|
||
|
|
<br>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>08</em></td>
|
||
|
|
<td align="left" valign="top">The registration containing a country or region code and
|
||
|
|
IBM customer number. This value is the same as specifying *CUSTOMER as the
|
||
|
|
registration type when a product load or product definition is created.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Registration value.</strong> The registration value associated with
|
||
|
|
the product. This is a 14-character value. If the registration type is not
|
||
|
|
specified, this field should contain blanks. Together, the registration type
|
||
|
|
and registration value make up the registration ID for the product.</p>
|
||
|
|
|
||
|
|
<p><strong>Release.</strong> The version, release, and modification level of
|
||
|
|
the product for which support is being added or removed. The release must be in
|
||
|
|
the format VxRyMz. Valid values for <em>x</em> and <em>y</em> are 0 through 9.
|
||
|
|
Valid values for <em>z</em> are 0 through 9 or A through Z. For example, V2R1M0
|
||
|
|
is Version 2, Release 1, Modification 0.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Messages</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 valign="top" width="15%">CPF0C1D E</td>
|
||
|
|
<td valign="top" width="85%">Load ID &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C2A E</td>
|
||
|
|
<td valign="top">Error occurred while processing QSZSPTPR API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C2B E</td>
|
||
|
|
<td valign="top">Code load ID &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C23 E</td>
|
||
|
|
<td valign="top">Support could be lost for some products.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C26 E</td>
|
||
|
|
<td valign="top">Length of product information not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C27 E</td>
|
||
|
|
<td valign="top">Product identifier &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C28 E</td>
|
||
|
|
<td valign="top">Registration identifier not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C29 E</td>
|
||
|
|
<td valign="top">Requested action not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C4A E</td>
|
||
|
|
<td valign="top">Product record not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C4C E</td>
|
||
|
|
<td valign="top">Cannot allocate object &1 in library &2.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C4E E</td>
|
||
|
|
<td valign="top">Requested product already supported.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C4F E</td>
|
||
|
|
<td valign="top">Product &1 release &4 option &3 code load must be
|
||
|
|
supported before a language can be supported.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C50 E</td>
|
||
|
|
<td valign="top">Requested product not supported.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C8A E</td>
|
||
|
|
<td valign="top">Product option &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF0C87 E</td>
|
||
|
|
<td valign="top">Library &1 not allowed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF24B4 E</td>
|
||
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF1 E</td>
|
||
|
|
<td valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C21 E</td>
|
||
|
|
<td valign="top">Format name &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C29 E</td>
|
||
|
|
<td valign="top">Object name &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C90 E</td>
|
||
|
|
<td valign="top">Literal value cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF358A E</td>
|
||
|
|
<td valign="top">Release not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872 E</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
||
|
|
Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V4R4
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|