871 lines
26 KiB
HTML
871 lines
26 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>Retrieve Image Catalog Details (QVOIRCLD) 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. -->
|
||
|
|
<!-- Created for V5R4 on 040714 by JJM -->
|
||
|
|
<!-- Change history: -->
|
||
|
|
<!-- 040714 JJM New API for V5R4 -->
|
||
|
|
<!-- 041016 JJM Add library name to input and CPF9810 -->
|
||
|
|
<!-- Add dependent clg field to RCLD0100 -->
|
||
|
|
<!-- Add reference clg name and lib to RCLD0100 -->
|
||
|
|
<!-- Add image size to RCLD0200 -->
|
||
|
|
<!-- 041210 JJM Add image file name and length to RCLD0200 -->
|
||
|
|
<!-- Add image file name length to RCLD0300 -->
|
||
|
|
<!-- Change length of file name to 512 bytes -->
|
||
|
|
<!-- and reorder fields -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
|
||
|
|
|
||
|
|
<h2><img src="delta.gif" alt="Start of change">Retrieve Image Catalog Details (QVOIRCLD) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 90%;">
|
||
|
|
<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%">Receiver variable</td>
|
||
|
|
<td align="left" valign="top" width="20%">Output</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 receiver variable</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">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">Qualified image catalog name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(20)</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 <strong>Retrieve Image Catalog Details (QVOIRCLD) API</strong> retrieves the contents of an image catalog. The QVOIRCLD API places the information in the receiver variable.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
<dl>
|
||
|
|
<dt><em>Image Catalog Authority</em></dt>
|
||
|
|
<dd>*USE</dd>
|
||
|
|
<dt><em>Image Catalog Library Authority</em></dt>
|
||
|
|
<dd>*EXECUTE</dd>
|
||
|
|
<dt><em>Image Catalog Lock</em></dt>
|
||
|
|
<dd>*SHRRD</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt><strong>Receiver variable</strong></dt>
|
||
|
|
<dd>OUTPUT; CHAR(*)
|
||
|
|
<p>The receiver variable that is to receive the catalog information. You
|
||
|
|
can specify the size of the area to be smaller than the format requested
|
||
|
|
as long as you specify the length parameter correctly. As a result,
|
||
|
|
the API returns only the data that the area can hold.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
<p>The length of the receiver variable provided. The length of the
|
||
|
|
receiver variable parameter may be specified up to the size of the
|
||
|
|
receiver variable specified in the user program. If the length of
|
||
|
|
the receiver variable parameter specified is larger than the
|
||
|
|
allocated size of the receiver variable specified in the user
|
||
|
|
program, the results are not predictable. The minimum length
|
||
|
|
is 8 bytes.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format name</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
<p>The format of image catalog entries to list. You can use one of the following format names:</p>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="25 75" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><strong><a href="#header_01">RCLD0100</a></strong></td>
|
||
|
|
<td align="left" valign="top">Header information only.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><strong><a href="#header_02">RCLD0200</a></strong></td>
|
||
|
|
<td align="left" valign="top">Header information and entry list for optical type image catalogs.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><strong><a href="#header_03">RCLD0300</a></strong></td>
|
||
|
|
<td align="left" valign="top">Header information and entry list for tape type image catalogs.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
<!--
|
||
|
|
<dl>
|
||
|
|
<dt><strong>RCLD0100</strong></dt>
|
||
|
|
<dd>Header information only. For details, see <XYZZXZ>RCLD0100 Format</XYZZXZ><br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
<dt><strong>RCLD0200</strong></dt>
|
||
|
|
<dd>Header information and entry list for optical type image catalogs. For details, see <XYZZXZ>RCLD0200 Format</XYZZXZ><br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
<dt><strong>RCLD0300</strong></dt>
|
||
|
|
<dd>Header information and entry list for tape type image catalogs. For details, see <XYZZXZ>RCLD0300 Format</XYZZXZ><br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
-->
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Qualified image catalog name</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(20)
|
||
|
|
<p>The image catalog about which to list information, and the library in
|
||
|
|
which it is located. The first 10 characters contain the object name, and the
|
||
|
|
second 10 characters contain the library name.</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="header_01">Format RCLD0100</a></h3>
|
||
|
|
|
||
|
|
For detailed
|
||
|
|
descriptions of the fields in this table, see <a href="#Header_8">Field
|
||
|
|
Descriptions</a>.
|
||
|
|
|
||
|
|
<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%">Bytes returned</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">Bytes available</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Image catalog type</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">9</td>
|
||
|
|
<td align="center" valign="top">9</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Image catalog status</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">10</td>
|
||
|
|
<td align="center" valign="top">A</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Reference image catalog indicator</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">11</td>
|
||
|
|
<td align="center" valign="top">B</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Dependent image catalog indicator</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="center" valign="top">C</td>
|
||
|
|
<td align="left" valign="top">CHAR(50)</td>
|
||
|
|
<td align="left" valign="top">Image catalog text</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">62</td>
|
||
|
|
<td align="center" valign="top">3E</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Virtual device name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">72</td>
|
||
|
|
<td align="center" valign="top">48</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Offset to image catalog directory</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">76</td>
|
||
|
|
<td align="center" valign="top">4C</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of image catalog directories</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">80</td>
|
||
|
|
<td align="center" valign="top">50</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of image catalog directory</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">84</td>
|
||
|
|
<td align="center" valign="top">54</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">CCSID of image catalog directory</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">88</td>
|
||
|
|
<td align="center" valign="top">58</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Offset to first image catalog entry</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">92</td>
|
||
|
|
<td align="center" valign="top">5C</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of image catalog entries returned</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">96</td>
|
||
|
|
<td align="center" valign="top">60</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of image catalog entry</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">100</td>
|
||
|
|
<td align="center" valign="top">64</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of image catalog entries</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">104</td>
|
||
|
|
<td align="center" valign="top">68</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Reference image catalog name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">114</td>
|
||
|
|
<td align="center" valign="top">72</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Reference image catalog library name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">124</td>
|
||
|
|
<td align="center" valign="top">7C</td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" rowspan="2" colspan="2"> </td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Image catalog directory</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<!-- the entries are not returned with 0100, only with 0200 and 0300
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Image catalog entries</td>
|
||
|
|
</tr>
|
||
|
|
-->
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="header_02">Format RCLD0200</a></h3>
|
||
|
|
|
||
|
|
For detailed
|
||
|
|
descriptions of the fields in this table, see <a href="#Header_8">Field
|
||
|
|
Descriptions</a>.
|
||
|
|
|
||
|
|
<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%"> </td>
|
||
|
|
<td align="left" valign="top" width="60%">Returns everything from format RCLD0100</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td rowspan="10" colspan="2" align="left" valign="top">These fields repeat, in the order listed, for the number of image catalog entries returned.</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Image catalog entry index</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Image catalog entry status</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(100)</td>
|
||
|
|
<td align="left" valign="top">Image catalog entry text</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Write protect status</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(32)</td>
|
||
|
|
<td align="left" valign="top">Volume name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Access information</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Image size</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of image file name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(512)</td>
|
||
|
|
<td align="left" valign="top">Image file name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="header_03">Format RCLD0300</a></h3>
|
||
|
|
|
||
|
|
For detailed
|
||
|
|
descriptions of the fields in this table, see <a href="#Header_8">Field
|
||
|
|
Descriptions</a>.
|
||
|
|
|
||
|
|
<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%"> </td>
|
||
|
|
<td align="left" valign="top" width="60%">Returns everything from format RCLD0100</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td rowspan="16" colspan="2" align="left" valign="top">These fields repeat, in the order listed, for the number of image catalog entries returned.</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Image catalog entry index</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Image catalog entry status</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(100)</td>
|
||
|
|
<td align="left" valign="top">Image catalog entry text</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Write protect status</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(6)</td>
|
||
|
|
<td align="left" valign="top">Volume name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4) UNSIGNED</td>
|
||
|
|
<td align="left" valign="top">Maximum volume size</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(8) UNSIGNED</td>
|
||
|
|
<td align="left" valign="top">Current number of bytes available</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(8) UNSIGNED</td>
|
||
|
|
<td align="left" valign="top">Current number of bytes used by volume</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4) UNSIGNED</td>
|
||
|
|
<td align="left" valign="top">Percent used (units in tenths)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4) UNSIGNED</td>
|
||
|
|
<td align="left" valign="top">First file sequence number in the virtual volume</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4) UNSIGNED</td>
|
||
|
|
<td align="left" valign="top">Last file sequence number in the virtual volume</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Density</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Type of volume</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of image file name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(512)</td>
|
||
|
|
<td align="left" valign="top">Image file name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="Header_8">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Access information.</strong> The type of access allowed to this image catalog entry. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Read only.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Read/Write.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<!-- commented out worse looking alternative methods of doing an entry
|
||
|
|
<dl>
|
||
|
|
<dt><strong>0</strong></dt>
|
||
|
|
<dd>Read only.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
<dt><strong>1</strong></dt>
|
||
|
|
<dd>Read/Write.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<ul>
|
||
|
|
<li>0 Read only.</li>
|
||
|
|
<li>1 Read/Write.</li>
|
||
|
|
</ul>
|
||
|
|
-->
|
||
|
|
|
||
|
|
<p><strong>Bytes available.</strong> The number of bytes of data available to be returned. All available data is returned if enough space is provided.</p>
|
||
|
|
|
||
|
|
<p><strong>Bytes returned.</strong> The number of bytes of data returned.</p>
|
||
|
|
|
||
|
|
<p><strong>CCSID of image catalog directory.</strong> The CCSID of the image catalog directory returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Current number of bytes available.</strong> The current number of bytes available by this virtual volume.</p>
|
||
|
|
|
||
|
|
<p><strong>Current number of bytes used by volume.</strong> The current number of bytes being used by this virtual volume.</p>
|
||
|
|
|
||
|
|
<p><strong>Density.</strong> The density associated with this image catalog entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Dependent image catalog indicator.</strong> An indicator of whether this image catalog is a dependent image catalog. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">This catalog is not a dependent catalog.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">This catalog is a dependent catalog.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>First file sequence number in the virtual volume.</strong> The sequence number associated with the first file in this virtual volume. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Unknown.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1-n</em></td>
|
||
|
|
<td align="left" valign="top">The sequence number associated with the first file in this virtual volume.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Image catalog directory.</strong> The Integrated File System (IFS) directory associated with the image catalog.</p>
|
||
|
|
|
||
|
|
<p><strong>Image catalog entry index.</strong> The index number of this image catalog entry. An image catalog entry index is a number between 1 and 256.</p>
|
||
|
|
|
||
|
|
<p><strong>Image catalog entry status.</strong> The status of this image catalog entry. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Unloaded.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Loaded.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">Mounted.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>3</em></td>
|
||
|
|
<td align="left" valign="top">Error.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Image catalog entry text.</strong> The text associated with this image catalog entry. This text will be returned in UTF-16, coded character set identifier (CCSID) 1200.</p>
|
||
|
|
|
||
|
|
<p><strong>Image catalog status.</strong> The current status of the image catalog. The status indicates whether the image catalog is loaded into a virtual optical device or not. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Not ready.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Ready.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Image catalog text.</strong> The text description associated with the image catalog.</p>
|
||
|
|
|
||
|
|
<p><strong>Image catalog type.</strong> The type of this image catalog. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">This catalog is an optical type catalog.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">This catalog is a tape type catalog.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Image file name.</strong> The Integrated File System name of this image catalog entry. The image catalog entry name returned will be represented in UTF-16.</p>
|
||
|
|
|
||
|
|
<p><strong>Image size.</strong> The size of the optical image file in MB. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">The size is not available (for example, the entry is not mounted, or the image file is not available).</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>n</em></td>
|
||
|
|
<td align="left" valign="top">The size of the optical image file in MB.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
<p><strong>Last file sequence number in the virtual volume.</strong> The sequence number associated with the last file in this image. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Unknown.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1-n</em></td>
|
||
|
|
<td align="left" valign="top">The sequence number associated with the last file in this virtual volume.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Length of image catalog directory.</strong> The length, in bytes, of the image catalog directory that is associated with the image catalog.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of image catalog entry.</strong> The length of each image catalog entry in the image catalog.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of image file name.</strong> The length, in bytes, of the image file name.</p>
|
||
|
|
|
||
|
|
<p><strong>Maximum volume size.</strong> The maximum size allowed for this virtual volume in megabytes.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of image catalog directories.</strong> The number of image catalog directories associated with this image catalog.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of image catalog entries.</strong> The number of image catalog entries in the image catalog.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of image catalog entries returned.</strong> The number of image catalog entries returned. When format RCLD0100 is specified, this field will be zero.</p>
|
||
|
|
|
||
|
|
<p><strong>Offset to first image catalog entry.</strong> The offset to the first image catalog entry. When format RCLD0100 is specified, this field will be zero.</p>
|
||
|
|
|
||
|
|
<p><strong>Offset to image catalog directory.</strong> The offset to the image catalog directory name.</p>
|
||
|
|
|
||
|
|
<p><strong>Percent used (units in tenths).</strong> The percentage of this virtual volume that has been used.</p>
|
||
|
|
|
||
|
|
<p><strong>Reference image catalog indicator.</strong> An indicator of whether a dependent image catalog was created, with this catalog as the reference image catalog. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">This catalog is not a reference catalog.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">This catalog is a reference catalog.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Reference image catalog library name.</strong> The library containing the image catalog that was named as the reference catalog when this catalog was created. If this image catalog is not a dependent image catalog, this field will be blank.</p>
|
||
|
|
|
||
|
|
<p><strong>Reference image catalog name.</strong> The image catalog named as the reference catalog when this catalog was created. If this image catalog is not a dependent image catalog, this field will be blank.</p>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> Space included for alignment.</p>
|
||
|
|
|
||
|
|
<p><strong>Type of volume.</strong> The type associated with this image catalog entry. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">This is a nonlabeled virtual volume.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">This is a standard labeled virtual volume.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">The type of this virtual volume is unknown.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Virtual device name.</strong> The name of the virtual device that this image catalog is associated with. A blank virtual device name indicates that the catalog is not associated with a virtual device.</p>
|
||
|
|
|
||
|
|
<p><strong>Volume name.</strong> The volume name of this virtual volume.</p>
|
||
|
|
|
||
|
|
<p><strong>Write protect status.</strong> An indicator of whether this image file is write protected or not. The possible values are:</p>
|
||
|
|
<table>
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Not write protected.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Write protected.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">Unknown.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<h3><a name="header_9">Error Messages</a></h3>
|
||
|
|
|
||
|
|
<p>The following messages may be sent from this function:</p>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<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 valign="top">CPF3C21 E</td>
|
||
|
|
<td valign="top">Format name &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C24 E</td>
|
||
|
|
<td valign="top">Length of the receiver variable is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF1 E</td>
|
||
|
|
<td valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9802 E</td>
|
||
|
|
<td valign="top">Not authorized to object &2 in &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9803 E</td>
|
||
|
|
<td valign="top">Cannot allocate object &2 in library &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9804 E</td>
|
||
|
|
<td valign="top">Object &2 in library &3 damaged.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9810 E</td>
|
||
|
|
<td valign="top">Library &1 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFBC45 E</td>
|
||
|
|
<td valign="top">Image catalog &1 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFBC4B E</td>
|
||
|
|
<td valign="top">Image catalog &1 in use.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<img src="deltaend.gif" alt="End of change">
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R4
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"obj1.htm">Object APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|