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

635 lines
17 KiB
HTML
Raw Permalink 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>Generate CD-ROM Premastering Information (QLPCDINF,
QlpGenCdPremasteringInfo) 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. -->
<!-- QLPCDINF SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
<!-- at RCHVMW2 on 7 Oct 1998 at 18:23:30 -->
<!-- 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>Generate CD-ROM Premastering Information (QLPCDINF,
QlpGenCdPremasteringInfo) 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%">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">Distribution set map identifier</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">CD-ROM size</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">CD-ROM volume identifier prefix</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(30)</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Service Program: QLPCDROM<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Generate CD-ROM Premastering Information (OPM, QLPCDINF; ILE,
QlpGenCdPremasteringInfo) API allows you to do the following:</p>
<ul>
<li>Generate the distribution set map file
<p>A byte-stream file in the root directory is created and contains information
about which tape files reside on each CD-ROM volume
<img src="delta.gif" alt="Start of change">
(only for files needed by the i5/OS installation process, such as those
saved with SAVSYS or SAVLICPGM).
<img src="deltaend.gif" alt="End of change">
The name of this file is
\qlp<em>tbdnnnnnnn</em>, where <em>tbdnnnnnnn</em> is the name of the
distribution set map identifier that is provided as an input parameter to this
API. This file needs to be saved with the name QDSETMAP, using the CPYTOTAP
command, to the same set of tapes prior to being sent off for mastering to
CD-ROM. This file is written to each CD-ROM volume and is used by programs to
ease in intelligent prompting during system installation.</p>
</li>
<li>Retrieve information about the files that were saved when the job was
enabled for CD-ROM premastering using the Handle CD-ROM Premastering State
(QLPCDRST, QlpHandleCdState) API. (<strong>Note:</strong> Premastering is the
set of activities done in preparation for creating a master image as a template
for manufacturing a number of copies of a CD-ROM.)
<p>This information includes the tape file name, its corresponding CD-ROM file
name (only for files needed by the i5/OS installation process, such as those
saved with SAVSYS or SAVLICPGM), the CD-ROM volume it will be placed on, and
the volume serial position in this set of CD-ROMs.</p>
</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*EXCLUDE</dd>
<dt><em>QSYS Library Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>User Space Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>User Space Library Authority</em></dt>
<dd>*USE</dd>
<dt><em>User Space Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user space that receives the generated list and the library in which it
is located. The first 10 characters contain the user space name, and the second
10 characters contain the library name.</p>
<p>The following special values are allowed 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 current library is used to locate the user
space. If there is no current library, QGPL (general purpose library) is
used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list is used to locate the user
space.</td>
</tr>
</table>
<br>
</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 name follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>PCDL0100</em></td>
<td align="left" valign="top">Premastering information</td>
</tr>
<tr>
<td align="left" valign="top"></td>
<td align="left" valign="top">For more information, see <a href=
"#HDRPREMCD">PCDL0100 List Data Section</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Distribution set map identifier</strong></dt>
<dd>INPUT; CHAR(10)
<p>The distribution set map identifier that uniquely establishes this set of
CD-ROMs being premastered.</p>
<p>This name can only include the following characters:</p>
<ul>
<li>Uppercase characters (A-Z)</li>
<li>Numeric characters (0-9)</li>
<li>Underscore character (_)</li>
</ul>
<br>
<p>This identifier should be the same as that specified on the Handle CD-ROM
Premastering State API.</p>
</dd>
<dt><strong>CD-ROM size</strong></dt>
<dd>INPUT; BINARY(4)
<p>The size of the CD-ROM in megabytes that is used during mastering. This
information is needed to accurately calculate where the tape files reside on
CD-ROM.</p>
</dd>
<dt><strong>CD-ROM volume identifier prefix</strong></dt>
<dd>INPUT; CHAR(30)
<p>The prefix of the volume identifier for the CD-ROM volumes. Each CD-ROM will
be assigned a unique volume identifier starting with these 30 characters. A
2-digit numeric suffix is added to this prefix and then incremented for each
CD-ROM volume in the set. For example, the volume identifiers for a 3-volume
CD-ROM set when a prefix of MYCDS is used would be MYCDS01, MYCDS02, and
MYCDS03.</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="HDRPRELIST">Format of the Generated List</a></h3>
<p>The file member list consists of:</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>PCDL0100 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 list returned, see <a href="#HDRPCDRDE">Field Descriptions</a>.</p>
<p>When you retrieve 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>
<h4>Input Parameter Section</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(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 specified</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">CD-ROM size</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Distribution set map identifier</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">CD-ROM volume identifier prefix</td>
</tr>
</table>
<br>
<br>
<h4>Header Section</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(10)</td>
<td align="left" valign="top" width="60%">User space 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 library name used</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRPREMCD">PCDL0100 List Data Section</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(17)</td>
<td align="left" valign="top" width="60%">Tape file label</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(256)</td>
<td align="left" valign="top">CD-ROM file name</td>
</tr>
<tr>
<td align="center" valign="top">273</td>
<td align="center" valign="top">111</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">CD-ROM volume identifier</td>
</tr>
<tr>
<td align="center" valign="top">305</td>
<td align="center" valign="top">131</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">308</td>
<td align="center" valign="top">134</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">CD-ROM volume serial position</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRPCDRDE">Field Descriptions</a></h4>
<p><strong>CD-ROM file name.</strong> The name of the file as it will be on
CD-ROM.</p>
<p><strong>CD-ROM size.</strong> The size of the CD-ROM in megabytes that is
used during mastering.</p>
<p><strong>CD-ROM volume identifier.</strong> The CD-ROM volume identifier for
the CD-ROM volume that this file will be on.</p>
<p><strong>CD-ROM volume identifier prefix.</strong> The 30-character prefix of
the volume identifier for the CD-ROM volumes that was specified in the call to
the API.</p>
<p><strong>CD-ROM volume serial position.</strong> The position in a set of
CD-ROMs that this CD-ROM volume is in.</p>
<p><strong>Distribution set map identifier.</strong> The distribution set map
identifier that was specified in the call to the API.</p>
<p><strong>Format name specified.</strong> The format name that was passed to
this API on the call in the format name parameter.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Tape file label.</strong> The name of the file that was saved to
tape.</p>
<p><strong>User space library name specified.</strong> The name of the user
space library as specified on the call to the API.</p>
<p><strong>User space library name used.</strong> The actual name of the
library where this user space was found.</p>
<p><strong>User space name specified.</strong> The name of the user space as
specified on the call to the API.</p>
<p><strong>User space name used.</strong> The actual name of the user space
used to store the data listed.</p>
<br>
<h3>Error Messages</h3>
<table 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">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1E E</td>
<td align="left" valign="top">Required parameter &amp;1 omitted.</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">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this
API was 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">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 &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3DA4 E</td>
<td align="left" valign="top">CD-ROM size parameter &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3DA5 E</td>
<td align="left" valign="top">File will not fit on a CD-ROM.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3D9D E</td>
<td align="left" valign="top">Information about distribution set map not
found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3D9E E</td>
<td align="left" valign="top">Distribution set map identifier &amp;1 is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library
&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9804 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9807 E</td>
<td align="left" valign="top">One or more libraries in library list
deleted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9808 E</td>
<td align="left" valign="top">Cannot allocate one or more libraries on library
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td align="left" valign="top">Library &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">CPF9830 E</td>
<td align="left" valign="top">Cannot assign library &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: V3R6
<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>