857 lines
24 KiB
HTML
857 lines
24 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 Cartridge Information (QTARCTGI) 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 on 15 May 2002 by JKOCHAN -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- 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>Retrieve Cartridge Information (QTARCTGI) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
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">Device description</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">Requested cartridge ID</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(6)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Requested category</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(18)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</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 Retrieve Cartridge Information (QTARCTGI) API retrieves a list of the
|
|
cartridges in a tape library device and their attributes. This API provides a
|
|
function similar to the Display Tape Cartridge (DSPTAPCTG) command.</p>
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Device Description Authority</em></dt>
|
|
|
|
<dd>*USE</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>
|
|
|
|
<p><strong>Note:</strong> With the exception of the first cartridge information
|
|
entry, only complete cartridge information entries will be returned.</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 receiver
|
|
variable parameter may be specified up to the size of the receiver variable
|
|
specified in the user program. If the length of 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 content and format of the information being returned.</p>
|
|
|
|
<p>The RCTG0100 format must be used for the cartridge information. See
|
|
<a href="#HDRRCTG0100">RCTG0100 Format</a> to view the information returned for this
|
|
format.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Device description</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the tape library device containing the cartridge(s) for which
|
|
the data is to be returned.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Requested cartridge ID</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(6)
|
|
|
|
<p>The cartridge or cartridges for which the data is to be returned. This
|
|
parameter is used in conjunction with the Requested category parameter to
|
|
filter the data that is returned. This parameter can contain a specific
|
|
cartridge identifier, or a generic name of a cartridge identifier. A generic
|
|
name is a character string of one or more characters followed by an asterisk
|
|
(*); for example, ABC*. A generic name specifies all cartridge identifiers with
|
|
names that begin with the generic prefix. The following special value is also
|
|
supported:</p>
|
|
|
|
<dl>
|
|
<dt><em>*ALL</em></dt>
|
|
<dd>Information will be returned for all cartridges
|
|
in the specified tape library device that are in the requested category.<br><br></dd>
|
|
</dl>
|
|
</dd>
|
|
|
|
<dt><strong>Requested category</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(18)
|
|
|
|
<p>The category name and system for which the data is to be returned. This
|
|
parameter is used in conjunction with the Requested cartridge parameter to
|
|
filter the data that is returned. The requested category has two parts:</p>
|
|
|
|
<dl>
|
|
<dt><em>Category name</em></dt>
|
|
<dd>CHAR(10). A specific category name or one of the
|
|
following special values:
|
|
<br><br>
|
|
<dl>
|
|
<dt><em>*ALL</em></dt>
|
|
<dd>All categories that are owned by the specified
|
|
category system are searched for the requested cartridge indentifiers.<br><br></dd>
|
|
|
|
<dt><em>*NOSHARE</em></dt>
|
|
<dd>The *NOSHARE category that is owned by the
|
|
specified category system is searched for the requested cartridge
|
|
identifiers.<br><br></dd>
|
|
|
|
<dt><em>*IPL</em></dt>
|
|
<dd>The *IPL category that is owned by the specified
|
|
category system is searched for the requested cartridge identifiers.<br><br></dd>
|
|
|
|
<dt><em>*NL</em></dt>
|
|
<dd>The *NL category that is owned by the specified
|
|
category system is searched for the requested cartridge identifiers.<br><br></dd>
|
|
|
|
<dt><em>*SYSGEN</em></dt>
|
|
<dd>The *SYSGEN category that is owned by the
|
|
specified category system is searched for the requested cartridge
|
|
identifiers.<br><br></dd>
|
|
|
|
<dt><em>*CNV</em></dt>
|
|
<dd>The *CNV category that is owned by the specified
|
|
category system is searched for the requested cartridge identifiers.<br><br></dd>
|
|
|
|
<dt><em>*SHARE400</em></dt>
|
|
<dd>The *SHARE400 category is searched for the
|
|
requested cartridge identifiers. The category system field is not used for this
|
|
category and must be set to blanks.<br><br></dd>
|
|
|
|
<dt><em>*INSERT</em></dt>
|
|
<dd>The *INSERT category is searched for the
|
|
requested cartridge identifiers. The category system field is not used for this
|
|
category and must be set to blanks.<br><br></dd>
|
|
|
|
<dt><em>*EJECT</em></dt>
|
|
<dd>The *EJECT category is searched for the requested
|
|
cartridge identifiers. The category system field is not used for this category
|
|
and must be set to blanks.<br><br></dd>
|
|
</dl>
|
|
</dd>
|
|
|
|
<dt><em>Category system</em></dt>
|
|
<dd>CHAR(8). A specific system name or one of the
|
|
following special values:
|
|
<br><br>
|
|
<dl>
|
|
<dt><em>*CURRENT</em></dt>
|
|
<dd>All categories with the specified category name
|
|
that are owned by the current system are searched for the requested cartridge
|
|
indentifiers.<br><br></dd>
|
|
|
|
<dt><em>*ALL</em></dt>
|
|
<dd>All categories with the specifed category name
|
|
that are owned by any system are searched for the requested cartridge
|
|
identifiers.<br><br></dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
</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="HDRRCTG100">RCTG0100 Format</a></h3>
|
|
|
|
<p>The following table shows the information that is returned for the RCTG0100
|
|
format. For more details about the fields in the following table, see
|
|
<a href="#HDRFLDXX">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%">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 cartridge information</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 cartridge information entries</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 cartridge information entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Cartridge information</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="CTGINFO">Cartridge information</a></h3>
|
|
|
|
<p>The current cartridge attributes. Each cartridge information entry has the
|
|
following format. For more details about the fields in the following table, see
|
|
<a href="#HDRFLDXX">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(6)</td>
|
|
<td align="left" valign="top" width="60%">Cartridge ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Volume ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">12</td>
|
|
<td align="center" valign="top" width="10%">C</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Tape library name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">22</td>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Category</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">32</td>
|
|
<td align="center" valign="top" width="10%">20</td>
|
|
<td align="left" valign="top" width="20%">CHAR(8)</td>
|
|
<td align="left" valign="top" width="60%">Category system</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Density</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">50</td>
|
|
<td align="center" valign="top" width="10%">32</td>
|
|
<td align="left" valign="top" width="20%">CHAR(7)</td>
|
|
<td align="left" valign="top" width="60%">Change date</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">57</td>
|
|
<td align="center" valign="top">39</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Change time</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">63</td>
|
|
<td align="center" valign="top" width="10%">3F</td>
|
|
<td align="left" valign="top" width="20%">CHAR(7)</td>
|
|
<td align="left" valign="top" width="60%">Reference date</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">70</td>
|
|
<td align="center" valign="top">46</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Reference time</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">76</td>
|
|
<td align="center" valign="top" width="10%">4C</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Location</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">Location indicator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">87</td>
|
|
<td align="center" valign="top" width="10%">57</td>
|
|
<td align="left" valign="top" width="20%">CHAR(2)</td>
|
|
<td align="left" valign="top" width="60%">Volume status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">89</td>
|
|
<td align="center" valign="top">59</td>
|
|
<td align="left" valign="top">CHAR(17)</td>
|
|
<td align="left" valign="top">Owner ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">106</td>
|
|
<td align="center" valign="top" width="10%">6A</td>
|
|
<td align="left" valign="top" width="20%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="60%">Write protection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">107</td>
|
|
<td align="center" valign="top">6B</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Code</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">108</td>
|
|
<td align="center" valign="top" width="10%">6C</td>
|
|
<td align="left" valign="top" width="20%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="60%">Cartridge ID source</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">109</td>
|
|
<td align="center" valign="top">6D</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Import/Export slot</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">110</td>
|
|
<td align="center" valign="top" width="10%">6E</td>
|
|
<td align="left" valign="top" width="20%">CHAR(2)</td>
|
|
<td align="left" valign="top" width="60%">Media type</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRFLDXX">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>Cartridge ID.</strong> The cartridge identifier for the
|
|
cartridge.</p>
|
|
|
|
<p><strong>Cartridge ID source.</strong> The type of cartridge ID. The
|
|
following values can be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The volume identifier is used for the cartridge
|
|
ID.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The cartridge ID is generated by the system.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">The cartridge ID was read from the bar code label
|
|
on the cartridge.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Category.</strong> The category assigned to the cartridge.</p>
|
|
|
|
<p><strong>Category system.</strong> The name of the system that owns the
|
|
category assigned to the cartridge.</p>
|
|
|
|
<p><strong>Change date.</strong> The date the cartridge was last used for
|
|
output operations. The date is returned with the following format - CYYMMDD. If
|
|
no change date is available the field is set to blanks.</p>
|
|
|
|
<p><strong>Change time.</strong> The time the cartridge was last used for
|
|
output operations. The time is returned with the following format HHMMSS. If no
|
|
change time is available the field is set to blanks.</p>
|
|
|
|
<p><strong>Code.</strong> The encoding used for the data on tape. The following
|
|
values can be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>blank</em></td>
|
|
<td align="left" valign="top">The encoding is unknown.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">ASCII encoding is used.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">EBCDIC encoding is used.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Density.</strong> The last known cartridge density. If the density
|
|
is unknown the field is set to blanks.</p>
|
|
|
|
<p><strong>Import/Export slot.</strong> Whether or not the cartridge is in an
|
|
Import/Export slot. The following values can be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The cartridge is not in an import/export
|
|
slot.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The cartridge is in an import/export slot.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Length of cartridge information entry.</strong> When cartridge
|
|
information is available this field is set to the length, in bytes, of a single
|
|
cartridge information entry. A value of zero is returned if the cartridge
|
|
information is not available.</p>
|
|
|
|
<p><strong>Location.</strong> The current location of the cartridge. The
|
|
location will be set to either a slot number (if available) or a tape resource
|
|
name. The following value may also be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>blanks</em></td>
|
|
<td align="left" valign="top">Slot number is not available.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<p><strong>Location indicator.</strong> This field indicates what type of
|
|
location information is returned. Possible values follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The cartridge is mounted in a tape resource in
|
|
the tape library.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The cartridge is in a storage slot in the tape
|
|
library.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Media type.</strong> The media type read from the bar code label on
|
|
the cartridge. If there is no bar code reader the field is set to blank.</p>
|
|
|
|
<p><strong>Number of cartridge information entries.</strong> The number
|
|
cartridge information entries returned. A value of zero is returned if the
|
|
cartridge information is not available.</p>
|
|
|
|
<p><strong>Offset to cartridge information.</strong> The offset, in bytes, to
|
|
the cartridge information. A value of zero is returned if the cartridge
|
|
information is not available.</p>
|
|
|
|
<p><strong>Owner ID.</strong> The owner of the cartridge. This information is
|
|
read from the tape volume labels. The following other values can be
|
|
returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NL</em></td>
|
|
<td align="left" valign="top">The cartridge is a non-labeled tape.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*BLANK</em></td>
|
|
<td align="left" valign="top">The owner ID in the tape labels was blank.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>blanks</em></td>
|
|
<td align="left" valign="top">The owner ID is unknown</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reference date.</strong> The date the cartridge was last used. The
|
|
date is returned with the following format - CYYMMDD. If no reference date is
|
|
available the field is set to blanks.</p>
|
|
|
|
<p><strong>Reference time.</strong> The time the cartridge was last used. The
|
|
time is returned with the following format HHMMSS. If no reference time is
|
|
available the field is set to blanks.</p>
|
|
|
|
<p><strong>Tape Library name.</strong> The name of the tape library containing
|
|
the cartridge.</p>
|
|
|
|
<p><strong>Volume ID.</strong> The volume identifier for the cartridge read
|
|
from the tape volume labels. The following other values can be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NL</em></td>
|
|
<td align="left" valign="top">The volume is a non-labeled tape.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>blanks</em></td>
|
|
<td align="left" valign="top">The volume ID is unknown</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<p><strong>Volume status.</strong> The status of the cartridge. Possible values
|
|
follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>01</em></td>
|
|
<td align="left" valign="top">The cartridge is available.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>02</em></td>
|
|
<td align="left" valign="top">The cartridge is mounted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>03</em></td>
|
|
<td align="left" valign="top">The cartridge is not available.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>04</em></td>
|
|
<td align="left" valign="top">The cartridge is ejected.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>05</em></td>
|
|
<td align="left" valign="top">The cartridge is in error state.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>06</em></td>
|
|
<td align="left" valign="top">The cartridge is inserted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>07</em></td>
|
|
<td align="left" valign="top">The cartridge has a duplicate cartridge ID.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Write Protection.</strong> Indicates whether or not the cartridge is
|
|
write protected. The following values can be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The cartridge is not write protected.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The cartridge is write protected.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>blank</em></td>
|
|
<td align="left" valign="top">The cartridge write protect status is
|
|
unknown.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">CPF24B4 E</td>
|
|
<td align="left" valign="top" width="85%">Severe error while addressing parameter
|
|
list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C19 E</td>
|
|
<td align="left" valign="top">Error occurred with receiver variable
|
|
specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C24 E</td>
|
|
<td align="left" valign="top">Length of the receiver variable is not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C3C E</td>
|
|
<td align="left" valign="top">Value for parameter &1 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">CPF6708 E</td>
|
|
<td align="left" valign="top">Command ended due to error.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6718 E</td>
|
|
<td align="left" valign="top">Cannot allocate device &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF673A E</td>
|
|
<td align="left" valign="top">Device &1 not varied on.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6745 E</td>
|
|
<td align="left" valign="top">Device &1 not a media library device.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF67A1 E</td>
|
|
<td align="left" valign="top">Cartridge &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF67A6 E</td>
|
|
<td align="left" valign="top">Category does not exist.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF67D2 E</td>
|
|
<td align="left" valign="top">Cartridge does not exist in specified
|
|
category.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9802 E</td>
|
|
<td align="left" valign="top">Not authorized to object &2 in &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9814 E</td>
|
|
<td align="left" valign="top">Device &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library
|
|
&2 ended. Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
<hr>
|
|
API introduced: V5R3
|
|
|
|
<hr>
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"back1.htm">Backup and Recovery APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|