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

451 lines
13 KiB
HTML
Raw Normal View History

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>Copy Program Temporary Fix to Save File (QPZCPYSV) 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. -->
<!-- QPZCPYSV SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
<!-- at RCHVMW2 on 7 Oct 1998 at 18:37:48 -->
<!-- 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>Copy Program Temporary Fix to Save File (QPZCPYSV) 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%">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">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">3</td>
<td align="left" valign="top">Device name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</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>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Copy Program Temporary Fix to Save File (QPZCPYSV) API allows you to
copy all program temporary fixes (PTFs) for the selected product from the media
and store them in *SERVICE. The PTFs can then be displayed, loaded, or copied
using the PTF commands. PTF
Group information can also be copied in addition to the PTFs.</p>
<p>A save file is created in library QGPL for each PTF that is copied. You can
use the Retrieve Program Temporary Fix Information (QPZRTVFX) API to obtain the
name of the save file.</p>
<p>If the PTF already exists in *SERVICE, the PTF is not copied.</p>
<p>Cover letters are copied to file QAPZCOVER in library QGPL.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Device</em></dt>
<dd>*USE<br><br></dd>
<dt><em>Library QGPL</em></dt>
<dd>*USE</dd>
</dl>
<p>Lock conflicts may occur if this API is called while another PTF or PTF group operation is in progress.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Product information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The information needed to put the PTF into the *SERVICE device.</p>
</dd>
<dt><strong>Product information format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The name of the format that describes the product information. The only
format name supported is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>PTFV0100</em></td>
<td align="left" valign="top">See <a href="#HDRPZCPYV1">PTFV0100
Format</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Device name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the optical device or tape device that contains the PTFs to be
copied.</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="HDRPZCPYV1">PTFV0100 Format</a></h3>
<p>The following table describes the format for the product information
parameter. The format identifies the product of the PTFs to be copied. For
detailed descriptions of the fields, see <a href="#HDRPZCPYV2">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 product information</td>
</tr>
<tr>
<td align="CENTER" valign="top">4</td>
<td align="CENTER" valign="top">4</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Product ID</td>
</tr>
<tr>
<td align="CENTER" valign="top">11</td>
<td align="CENTER" valign="top">B</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Release</td>
</tr>
<tr>
<td align="CENTER" valign="top">17</td>
<td align="CENTER" valign="top">11</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Automatically support product</td>
</tr>
<tr>
<td align="CENTER" valign="top">18</td>
<td align="CENTER" valign="top">12</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Copy PTFs</td>
</tr>
<tr>
<td align="CENTER" valign="top">19</td>
<td align="CENTER" valign="top">13</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Copy PTF Groups</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRPZCPYV2">Field Descriptions</a></h3>
<p><strong>Automatically support product.</strong> Indicates that when a PTF
for a product currently not supported or installed on the system is found on
the media, the product automatically will be marked as supported and the PTF
will be copied. If the PTF affects a National Language Version, only the
primary language of the system will be supported automatically. You can use the
Add or Remove Product Support (QSZSPTPR) API to add support for additional
languages.</p>
<p>This field is ignored when *SUPPTD is specified in the product ID field.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not automatically support the product</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Automatically support the product</td>
</tr>
</table>
<p><strong>Copy PTFs.</strong>
Indicates which PTFs to copy. If this field is not specified, a value of 0 is
assumed.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Copy all PTFs regardless of their status.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Copy save files only for PTFs that do not have a
status of superseded, temporarily applied, or permanently applied on your
system.</td>
</tr>
</table>
<br>
<br>
<p><strong>Copy PTF
Groups.</strong> Indicates if the information for PTF Groups are to be copied
in addition to the PTFs. The PTF Groups can then be displayed using the
WRKPTFGRP command or retrieved using the QpzListPtfGroupDetails API. Note this
field only applies when the Product ID field specifies *ALL or *SUPPTD. If this
field is not specified, a value of 0 is assumed.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not copy the PTF Group information.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Copy an existing PTF Group of the same name only
when the level of the PTF Group being copied is higher than the level of the
PTF Group on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Copy an existing PTF Group of the same name only
when the level of the PTF Group being copied is equal to or higher than the
level of the PTF Group on the system.<br>
<br>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Always copy the PTF Group information. If a PTF
Group of the same name already exists on the system, it will be replaced.</td>
</tr>
</table>
<br>
<br>
<p><strong>Length of product information.</strong> The length of data in the
product information format, including this field. The only valid values for
this field are 18 or 20.</p>
<p><strong>Product ID.</strong> The name of the licensed products for which
PTFs are to be copied. You can use the following special values for the product
ID:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">PTFs for all products, releases, options, and
languages that are either supported or installed on this system are copied from
the media.
<p>Caution should be used when specifying this value and indicating automatic
support for the product. PTF media frequently contains PTFs for all products
available from your service provider. If you specify these values together, all
PTFs from the media are copied on to your system.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SUPPTD</em></td>
<td align="left" valign="top">PTFs for all products, releases, options, and
languages that are currently supported on this system are copied. PTFs for
products that are installed but not supported are not copied.</td>
</tr>
</table>
<p><strong>Release.</strong> The version, release, and modification of the
product. The release must be 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. Valid values for
<em>z</em> are 0 through 9 or A through Z. You can use the following special
value for the release:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">PTFs for all releases of the product will be
copied.</td>
</tr>
</table>
<p>A value other than *ALL is allowed only when a particular product is
specified for the product ID field.</p>
<br>
<h3>Error Messages</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<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">CPF35BE E</td>
<td align="left" valign="top">Product &amp;1 &amp;3 not supported or
installed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF35CC E</td>
<td align="left" valign="top">Library required for building PTFs already
exists.</td>
</tr>
<tr>
<td align="left" valign="top">CPF35E0 E</td>
<td align="left" valign="top">Error occurred copying PTF information.</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">CPF3C4B E</td>
<td align="left" valign="top">Value not valid for field &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C4C E</td>
<td align="left" valign="top">Value not valid for field &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">CPF358A E</td>
<td align="left" valign="top">Release not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3598 E</td>
<td align="left" valign="top">PTF operation already in progress.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36AF E</td>
<td align="left" valign="top">PTF group operation already in progress.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9814 E</td>
<td align="left" valign="top">Device &amp;1 not found.</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">CPF9825 E</td>
<td align="left" valign="top">Not authorized to device &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: 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>