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

378 lines
11 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>Log Program Temporary Fix Information (QPZLOGFX) 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. -->
<!-- QPZLOGFX SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
<!-- at RCHVMW2 on 7 Oct 1998 at 19:46:45 -->
<!-- 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Log Program Temporary Fix Information (QPZLOGFX) 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%">PTF Information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(50)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Request type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Qualified file name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Member name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</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;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Log PTF Information (QPZLOGFX) API allows you to specify the device from
which PTFs are loaded as *SERVICE. You can use the QPZLOGFX API to indicate
that a PTF or cover letter should be put into device *SERVICE.</p>
<p>PTFs are put into *SERVICE when they are received on the system using the
Copy PTF Save File (CPYPTFSAVF) or Send PTF Order (SNDPTFORD) command. These
commands put information about the PTF into the PTF database files so that the
PTF can be displayed with the Display PTF (DSPPTF) command. The PTF is then
loaded from device *SERVICE using the Load PTF (LODPTF) command. PTFs received
on the system by any other method are not in *SERVICE.</p>
<p>The PTF must exist in a save file with a valid name in the designated PTF
library before this API is called. If the PTF is put in a save file with a name
that is being used by another PTF, an error (CPF35BD) occurs. The save file
must be deleted or renamed. Checking is done to ensure that the correct library
is being used.</p>
<p>The cover letter must exist in the designated PTF cover letter file with a
valid member name before this API is called. If the member name is being used
by another PTF, an error (CPF35FE) will occur; you must delete the member or
rename it.</p>
<p>The product the PTF is for must be installed or supported.</p>
<p>The save file or member name must be Q plus the PTF ID. If that name is
being used by another PTF that is in *SERVICE, you must select another
name.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*EXCLUDE</dd>
</dl>
<br>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>PTF information</strong></dt>
<dd>INPUT; CHAR(50)
<p>The information needed to put the PTF into device *SERVICE. If the
information specified here does not match the information in the member or save
file specified on the qualified file name parameter, an error occurs (CPF35E6).
A check is done to verify that the PTF ID, product ID, and release specified
here match the PTF ID, product ID, and release of the cover letter or PTF. For
more information about this parameter see <a href="#HDRPTFINF3">PTF Information
Format</a>.</p>
</dd>
<dt><strong>Request type</strong></dt>
<dd>INPUT; CHAR(10)
<p>The type of log operation to be done.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LOGPTF</em></td>
<td align="left" valign="top">The PTF is to be put in device *SERVICE. Product
information from the save file is checked against the product information
passed into this API. Therefore, the PTF must exist in the save file specified
on the qualified file name parameter.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LOGCVR</em></td>
<td align="left" valign="top">A cover letter is to be put in device *SERVICE.
The cover letter must exist in the library, file, and member specified in the
qualified file name and member name parameters. Information from the member is
checked against the product information passed into the API.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Qualified file name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The file where the cover letter or PTF is located. If the request type
parameter is *LOGPTF, then this is the save file name and library name where
the PTF is located. If the request type is *LOGCVR, then this is the file and
library that contain the cover letter. The first 10 characters are the file
name and the second 10 characters are the library name.</p>
</dd>
<dt><strong>Member name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The member that contains the cover letter. This parameter is ignored if the
request type parameter is *LOGPTF.</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="HDRPTFINF3">PTF Information Format</a></h3>
<p>For a description of these fields, see <a href="#FIELD_DESC">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%">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 level</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="FIELD_DESC">Field Descriptions</a></h3>
<p><strong>Product ID.</strong> The product that the PTF or the cover letter is
for.</p>
<p><strong>PTF ID.</strong> The identifier of the PTF.</p>
<p><strong>Release level.</strong> The version, release, and modification level
of the PTF. 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, and valid values for <em>z</em> are 0 through 9 or A through
Z.</p>
<p><strong>Reserved.</strong> This field must be blank.</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 width="15%" valign="top">CPF0CB3 E</td>
<td width="85%" valign="top">Value for reserved field not valid.</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">CPF3C20 E</td>
<td align="left" valign="top">Error found by program &amp;1.</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">CPF35BD E</td>
<td align="left" valign="top">File name &amp;4 not valid for PTF &amp;1-&amp;2
&amp;3.</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">CPF35BF E</td>
<td align="left" valign="top">File name or library not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF35DE E</td>
<td align="left" valign="top">Request type &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF35E5 E</td>
<td align="left" valign="top">PTF save file &amp;1 in library &amp;2 does not
exist.</td>
</tr>
<tr>
<td align="left" valign="top">CPF35E6 E</td>
<td align="left" valign="top">File or member not processed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF35FE E</td>
<td align="left" valign="top">Member name &amp;7 not valid for PTF
&amp;1-&amp;2 &amp;3.</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">CPF3903 E</td>
<td align="left" valign="top">Cover letter not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3905 E</td>
<td align="left" valign="top">Member not valid cover letter.</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: V2R3
<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>