340 lines
9.2 KiB
HTML
340 lines
9.2 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>Set Cartridge Filter (QTASCTGF) 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 04 September 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>Set Cartridge Filter (QTASCTGF) 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%">Cartridge filter</td>
|
|
<td align="left" valign="top" width="20%">Input</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 cartridge filter</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">Requested action</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">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *EXCLUDE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Set Cartridge Filter (QTASCTGF) API sets a filter
|
|
that defines the cartridges that can be used by
|
|
tape library devices on the system.
|
|
</p>
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
<p>The caller of this API must have *ALLOBJ and *IOSYSCFG special
|
|
authorities.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Cartridge Filter</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The structure that sets the cartridge filter. </p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of cartridge filter</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the cartridge filter structure provided. The length must be set to
|
|
0 when the requested action value is 3. When the requested action value is 1, 2, or
|
|
4 the length specified must be large enough to contain the entire cartridge filter array
|
|
as defined by the fields in the cartridge filter parameter.
|
|
</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>Specifies the content and format of the information being set.</p>
|
|
|
|
<p>The SFTR0100 format must be used for the cartridge filter. See
|
|
<a href="#HDRSFTR0100">SFTR0100 Format</a> to view the information set for
|
|
this format.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Requested action</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The action to take with the filter provided. The possible values are: </p>
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The filter provided will replace the existing
|
|
filter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">The filter provided will be appended to the
|
|
existing filter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">The existing filter will be cleared.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">The filter provided will be removed from
|
|
the existing filter.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
</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="HDRSCTG100">SFTR0100 Format</a></h3>
|
|
|
|
<p>The following table shows the information that is set for the SFTR0100
|
|
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%">Offset to array</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">Number of array entries</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">Length of array entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">Array(*) of CHAR(*)</td>
|
|
<td align="left" valign="top">Cartridge filter array</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<h3><a name="HDRFLDXX">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Cartridge filter array. </strong>
|
|
An array of cartridge filters to be defined for the system.
|
|
Each array entry may consist of either 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.</p>
|
|
<p><strong>Note: </strong>The cartridge identifier is restricted
|
|
to characters A through Z, zero through nine, at-sign (@),
|
|
dollar-sign ($), and pound sign (#). A valid generic name contains
|
|
1 or more supported characters followed by a single asterisk (*)
|
|
and blanks. The at-sign (@), dollar-sign ($), pound sign (#), and
|
|
asterisk (*) characters must be provided in CCSID 37.</p>
|
|
<ul>
|
|
<li>@ = '7C'x</li>
|
|
<li>$ = '5B'x</li>
|
|
<li># = '7B'x</li>
|
|
<li>* = '5C'x</li>
|
|
</ul>
|
|
|
|
|
|
<p><strong>Length of array entry.</strong> This field is set to the length, in
|
|
bytes, of a single cartridge filter entry. This field must be set to 6.</p>
|
|
|
|
<p><strong>Number of array entries.</strong> The number of
|
|
cartridge filter entries specified. </p>
|
|
|
|
<p><strong>Offset to array.</strong> The offset, in
|
|
bytes, to the cartridge filter array. </p>
|
|
|
|
<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%">CPF222E E</td>
|
|
<td align="left" valign="top" width="85%">&1 special authority is required.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
|
<td align="left" valign="top">Severe error while addressing parameter
|
|
list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &1 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">CPF3C4C E</td>
|
|
<td align="left" valign="top">Value not valid for field &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td align="left" valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">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">CPF67C9 E</td>
|
|
<td align="left" valign="top">An error occurred during a cartridge filter
|
|
operation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF67CA E</td>
|
|
<td align="left" valign="top">Cartridge &1 is not correct.</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>
|