541 lines
15 KiB
HTML
541 lines
15 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 Catalogs (QVOIRCLG) 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 -->
|
|
<!-- 040930 JJM Add library names to output -->
|
|
<!-- 041005 JJM Add dependent and reference indicators -->
|
|
<!-- 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 Catalogs (QVOIRCLG) 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">Image catalog type</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</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 Catalogs (QVOIRCLG) API</strong> retrieves the list of image catalog names based on the image catalog type parameter.</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>None</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
<dd>OUTPUT; CHAR(*)
|
|
<p>The receiver variable that receives the information
|
|
requested. 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 catalogs to retrieve. You can use one of the following format names:</p>
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><strong><a href="#header_01">RCLG0100</a></strong></td>
|
|
<td align="left" valign="top">Catalog list information.</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
|
|
</dd>
|
|
|
|
<dt><strong>Image catalog type</strong></dt>
|
|
<dd>INPUT; CHAR(1)
|
|
<p>The type of image catalogs to include in the list.
|
|
You can specify one of the following types:</p>
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><strong>0</strong></td>
|
|
<td align="left" valign="top">Specify this value to get all types of image catalogs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><strong>1</strong></td>
|
|
<td align="left" valign="top">Specify this value to get optical type image catalogs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><strong>2</strong></td>
|
|
<td align="left" valign="top">Specify this value to get tape type image catalogs.</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="header_01">Format RCLG0100</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">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to first image catalog in list</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of image catalogs returned</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of image catalog list entry</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of image catalogs</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"> </td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Image catalog list</td>
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="header_02">Image Catalog List Entry</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">CHAR(10)</td>
|
|
<td align="left" valign="top">Image catalog name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">10</td>
|
|
<td align="center" valign="top" width="10%">A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Image catalog library name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</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">21</td>
|
|
<td align="center" valign="top">15</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">22</td>
|
|
<td align="center" valign="top">16</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">72</td>
|
|
<td align="center" valign="top">48</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">82</td>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Virtual device status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">86</td>
|
|
<td align="center" valign="top">56</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">87</td>
|
|
<td align="center" valign="top">57</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">88</td>
|
|
<td align="center" valign="top">58</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">98</td>
|
|
<td align="center" valign="top">62</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">108</td>
|
|
<td align="center" valign="top">6C</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
</table>
|
|
<br>
|
|
<br>
|
|
<h3><a name="Header_8">Field Descriptions</a></h3>
|
|
|
|
<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>Dependent image catalog indicator.</strong> An indicator of whether this image catalog is a dependent image catalog. The possible values are:</p>
|
|
<table>
|
|
<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>Image catalog library name.</strong> The name of the library containing the image catalog.
|
|
</p>
|
|
|
|
<p><strong>Image catalog list.</strong> The list of image catalogs and information.</p>
|
|
|
|
<p><strong>Image catalog name.</strong> The name of the image catalog from which the information was retrieved.</p>
|
|
|
|
<p><strong>Image catalog status.</strong> The current status of the image catalog. The possible values are:</p>
|
|
<table>
|
|
<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>
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Unknown.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Image catalog text.</strong> The text associated with this image catalog.</p>
|
|
|
|
<p><strong>Image catalog type.</strong> The type of this image catalog. The possible values are:</p>
|
|
<table>
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Optical type image catalog.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Tape type image catalog.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Length of image catalog list entry.</strong> The length of each image catalog entry in the list.</p>
|
|
|
|
<p><strong>Number of image catalogs.</strong> The number of image catalogs on the system of the type specified.</p>
|
|
|
|
<p><strong>Number of image catalogs returned.</strong> The number of image catalogs returned.</p>
|
|
|
|
<p><strong>Offset to first image catalog in list.</strong> The offset to the first image catalog in the list.</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>
|
|
<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>Virtual device name.</strong> The name of the virtual device associated with the image catalog. A blank virtual device name indicates that the catalog is not associated with a virtual device.</p>
|
|
|
|
<p><strong>Virtual device status.</strong> The current status of the virtual device. The possible values are:</p>
|
|
<table>
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Varied off.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Varied on.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Active.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">No virtual device.</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">CPF9804 E</td>
|
|
<td valign="top">Object &2 in library &3 damaged.</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>
|
|
|