friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/XTAPEMAN.htm

2679 lines
88 KiB
HTML
Raw Permalink Normal View History

Add readme and dist folders
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>Tape Management Exit Program</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. -->
<!-- Change History: -->
<!-- YYMMDD Userid : Description of the change -->
<!-- 040322 jkochan : DCR 99794 Add virtual tape information -->
<!-- 040630 dwenzel : DCR 99880 Add WORM information -->
<!-- BACKMST SCRIPT A converted by B2H R4.1 (346) (CMS) by v2kea304 at -->
<!-- RCHVMW2 on 26 April 1999 at 10:21:58 -->
<!-- File tagging validation completed Jan 2002 by v2cdijab -->
<!-- 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>Tape Management Exit Program</h2>
<div class="box" style="width: 70%;">
&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%">Exit description information</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">Label information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Operational information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Control value information</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;QSYSINC Member Name: ETATAPMG<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Exit Point Name: QIBM_QTA_TAPE_TMS<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Exit Point Format Name: TMS00200<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Tape Management exit program allows a tape management system to monitor
and control the use of volumes and devices used by the operating system for
most tape operations. The exit program is given control at certain points
during tape and library processing.</p>
<p><strong>Note:</strong> To use this exit program, you need the Media and
Storage Extension feature of the operating system.</p>
<p>The exit program is not given control when:</p>
<ul>
<li>The system is being installed</li>
<li>The tape job is a dedicated service tools (DST) tape job</li>
<li>The job is ending</li>
</ul>
<p>The operating system handles the setup, calling, and response
processing of the user exit program as specified through the registration
facility. (For information about registering an exit point with the
registration facility and adding an exit program to an exit point, <a href=
"reg1.htm">Registration Facility APIs</a>. This exit point supports only one
exit program.)</p>
<br>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Exit description information</strong></dt>
<dd>INPUT; CHAR(*)
<p>A description of the exit point. For a description of the format, see <a
href="#HDREDIF">Format of Exit Description Information</a>.</p>
</dd>
<dt><strong>Label information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The current volume label and the last header label or trailer label that was
written or read. For a description of the format, see <a href="#HDRLIF">Format
of Label Information</a>.</p>
</dd>
<dt><strong>Operational information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Information about the tape operation at the time the exit program is called.
For a description of the format, see <a href="#HDROIF">Format of Operational
Information</a>.</p>
</dd>
<dt><strong>Control value information</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>Information to control the tape operation being performed. This format is
set by i5/OS and may be changed by the exit programs to control tape
processing. For a description of the format, see <a href="#HDRCVIF2">Format of
Control Value Information</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDREDIF">Format of Exit Description Information</a></h3>
<p>The following table shows the format of the exit description information.
For a description of each field, see <a href="#HDREDIFF">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%">Length of exit description
information</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Tape position exit type</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Tape library device exit type</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDREDIFF">Field Descriptions</a></h3>
<p><strong>Length of exit description information.</strong> The length, in
bytes, of the exit description information.</p>
<p><strong>Tape library device exit type.</strong> An identifier that indicates
to the exit program the type of library processing occurring in the tape
library device. The values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Ignore<br>
Use the value specified in the tape position exit type field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Addition<br>
This exit type occurs immediately after the cartridge identifier is added to a
tape library device using the Add Tape Cartridge (ADDTAPCTG) command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Removal<br>
This exit type occurs immediately before the cartridge identifier is removed
from a tape library device using the Remove Tape Cartridge (RMVTAPCTG)
command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Category<br>
This exit type occurs immediately before the cartridge identifier has its
category changed from one category to another using the Change Tape Cartridge
(CHGTAPCTG) command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Mismatch<br>
This exit type occurs whenever a mismatch is found between a cartridge
identifier and the volume identifier on the tape cartridge.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">Mount failure<br>
This exit type occurs when a cartridge failed to be mounted. It gives the tape
management program an opportunity to choose a different cartridge.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Unload exit<br>
This exit type occurs after taking the option reject and unload. It gives the
tape management program an opportunity to choose the next cartridge to be
mounted.</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">Mount category exit<br>
This exit type occurs before a category is mounted through the use of the Set
Tape Category (SETTAPCGY) command with *MOUNTED specified for the option
parameter. This exit type allows the tape management program the opportunity to
reject the SETTAPCGY command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">Demount category exit<br>
This exit type occurs before a category is demounted through the use of the Set
Tape Category (SETTAPCGY) command with *DEMOUNTED specified for the option
parameter. This exit type allows the tape management program the opportunity to
reject the SETTAPCGY command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>9</em></td>
<td align="left" valign="top">Inventory success exit<br>
This exit type occurs after a successful inventory has been received from the
tape library device.</td>
</tr>
</table>
<p><strong>Tape position exit type.</strong> An identifier that indicates to
the exit program a reference to or the position of the tape. The values
are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Ignore<br>
Use the value specified in the tape library device exit type field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Start of file (SOF)<br>
This exit type occurs late in the open tape file processing but before any
steps related to mounting the first tape volume. This exit type provides
information concerning the open processing and allows the exit program to
select the first tape volume that will be read from or written to.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Start of volume (SOV)<br>
This exit type occurs immediately after the volume label is read unless an
initialize operation is being done. The purpose is to enable acceptance or
rejection of a tape volume and to allow the exit program to record the volume
actually used. This exit type occurs once for each volume processed. When an
initialize operation is being done, this exit type occurs before the volume
label is written. The current volume identifier (if known) is the volume
identifier before the initialize operation and the next volume identifier is
the new volume identifier.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Start of file section (SOS)<br>
This exit type occurs immediately after the HDR2 file header label is read on
input or immediately before the HDR2 label is written on output. Its purpose is
to enable acceptance or rejection of a tape that was previously accepted at
start-of-volume exit type. This exit type occurs once for each file
processed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">End of file section (EOS)<br>
This exit type occurs immediately after the EOV2 end-of-volume label is read on
input or immediately after the EOV2 label is written on output. This exit type
allows the exit program to select the next tape volume to be read from or
written to. This exit type occurs once for each volume processed except for the
last volume. (This exit type does not occur for single volume processes.)</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">End of file (EOF)<br>
This exit type occurs immediately after the EOF2 end-of-file label has been
read on input or immediately after the EOF2 label is written on output. Its
purpose is to inform the exit program that tape processing is complete.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Message<br>
This exit type occurs immediately before a message is sent by the tape manager.
The exit type informs the exit program that a message will be sent. If the
message is an inquiry message, the valid responses accepted by the message
handler may be the same as those that the i5/OS program accepts from the tape
management system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">End position<br>
This exit type occurs immediately before an end positioning occurs. End
positioning refers to whether the tape is rewound, unloaded, or left in leave
processing. (<strong>Leave processing</strong> refers to the use of
ENDOPT(*LEAVE) on a tape command.) The exit type is driven by the End Option
(ENDOPT) parameter on all tape commands. These values could be ENDOPT(*LEAVE),
ENDOPT(*REWIND), or ENDOPT(*UNLOAD). User-specified values cannot be overridden
in error scenarios because tape volumes are always rewound in error
situations.</td>
</tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">Command exit<br>
This exit type occurs before the start-of-file exit type and is designed to
allow tape management systems the ability to choose values that need to be
known before any operation is performed on the tape device. It is only enabled
as an exit type when options can be changed.</td>
</tr>
</table>
<br>
<br>
<h3><a name="Header_235">Examples of Exit Calls</a></h3>
<p>This example shows the sequence and the tape position exit types that result
from saving a library object (SAVLIB command) to one tape:</p>
<ul>
<li>Command (CMD)</li>
<li>Start of file (SOF)</li>
<li>Start of volume (SOV)</li>
<li>Start of file section (SOS)
<p>After this exit type, the data file is written.</p>
</li>
<li>End of file (EOF)</li>
<li>End position</li>
</ul>
<p>This example shows the sequence and the tape position exit types that result
from saving one library object to two tapes:</p>
<ul>
<li>Start of command (CMD)</li>
<li>Start of file (SOF)</li>
<li>Start of volume (SOV)</li>
<li>Start of file section (SOS)
<p>After this exit type, the first part of the data file is written.</p>
</li>
<li>End of file section (EOS)
<p>After this exit type, a new tape volume is requested.</p>
</li>
<li>Start of volume (SOV)</li>
<li>Start of file section (SOS)
<p>After this exit type, the next part of the data file is written to the
second tape.</p>
</li>
<li>End of file (EOF)</li>
<li>End position</li>
</ul>
<br>
<h3><a name="HDRLIF">Format of Label Information</a></h3>
<p> The following table shows the format of the label information. For a
description of each field, see <a href="#HDRLIFF">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%">Length of label information</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(80)</td>
<td align="left" valign="top">Current volume label</td>
</tr>
<tr>
<td align="center" valign="top">84</td>
<td align="center" valign="top">54</td>
<td align="left" valign="top">CHAR(80)</td>
<td align="left" valign="top">Last processed HDR1 or TRL1 label</td>
</tr>
<tr>
<td align="center" valign="top">164</td>
<td align="center" valign="top">A4</td>
<td align="left" valign="top">CHAR(80)</td>
<td align="left" valign="top">Last processed HDR2 or TRL2 label</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRLIFF">Field Descriptions</a></h3>
<p><strong>Current volume label.</strong> The volume label currently being
processed. If the tape position exit type is SOF or if the tape library device
exit type is addition, removal, category, or mismatch, this field contains
blanks. This field also contains blanks if a nonlabeled tape is being
processed.</p>
<p><strong>Last processed HDR1 or TRL1 label.</strong> The HDR1 file header
label or TRL1 trailer label that was last encountered. If the tape position
exit type is SOF or SOV or if the tape library device exit type is addition,
removal, category, or mismatch, this field contains blanks. This field also
contains blanks if a nonlabeled tape is being processed.</p>
<p><strong>Last processed HDR2 or TRL2 label.</strong> The HDR2 file header
label or TRL2 trailer label that was last encountered. If the tape position
exit type is SOF or SOV or if the tape library device exit type is addition,
removal, category, or mismatch, this field contains blanks. This field also
contains blanks if a nonlabeled tape is being processed.</p>
<p><strong>Length of label information.</strong> The length, in bytes, of the
label information.</p>
<br>
<h3><a name="HDROIF">Format of Operational Information</a></h3>
<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%">Length of operation information</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">Length of control value information</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">Tape operation</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="center" valign="top">9</td>
<td align="left" valign="top">CHAR(17)</td>
<td align="left" valign="top">Data file label</td>
</tr>
<tr>
<td align="center" valign="top">26</td>
<td align="center" valign="top">1A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Tape device file name</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Tape device file library name</td>
</tr>
<tr>
<td align="center" valign="top">46</td>
<td align="center" valign="top">2E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Current device name</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Current volume identifier</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">Next device name</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Next volume identifier</td>
</tr>
<tr>
<td align="center" valign="top">78</td>
<td align="center" valign="top">4E</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Current device type</td>
</tr>
<tr>
<td align="center" valign="top">82</td>
<td align="center" valign="top">52</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Current tape density</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Data check on write</td>
</tr>
<tr>
<td align="center" valign="top">93</td>
<td align="center" valign="top">5D</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Next tape density</td>
</tr>
<tr>
<td align="center" valign="top">103</td>
<td align="center" valign="top">67</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Tape device ready status</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Tape volume initialize status</td>
</tr>
<tr>
<td align="center" valign="top">105</td>
<td align="center" valign="top">69</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Initialize new volume label</td>
</tr>
<tr>
<td align="center" valign="top">106</td>
<td align="center" valign="top">6A</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">Logical block identifier</td>
</tr>
<tr>
<td align="center" valign="top">138</td>
<td align="center" valign="top">8A</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Cartridge identifier</td>
</tr>
<tr>
<td align="center" valign="top">144</td>
<td align="center" valign="top">90</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Category name</td>
</tr>
<tr>
<td align="center" valign="top">154</td>
<td align="center" valign="top">9A</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Category system name</td>
</tr>
<tr>
<td align="center" valign="top">162</td>
<td align="center" valign="top">A2</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Mismatch status</td>
</tr>
<tr>
<td align="center" valign="top">163</td>
<td align="center" valign="top">A3</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library device name</td>
</tr>
<tr>
<td align="center" valign="top">173</td>
<td align="center" valign="top">AD</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Library device status</td>
</tr>
<tr>
<td align="center" valign="top">174</td>
<td align="center" valign="top">AE</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Library device mode</td>
</tr>
<tr>
<td align="center" valign="top">175</td>
<td align="center" valign="top">AF</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">System restricted state status</td>
</tr>
<tr>
<td align="center" valign="top">176</td>
<td align="center" valign="top">B0</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Tape volume write protection status</td>
</tr>
<tr>
<td align="center" valign="top">177</td>
<td align="center" valign="top">B1</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Message identifier</td>
</tr>
<tr>
<td align="center" valign="top">184</td>
<td align="center" valign="top">B8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message type</td>
</tr>
<tr>
<td align="center" valign="top">194</td>
<td align="center" valign="top">C2</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message queue or program name</td>
</tr>
<tr>
<td align="center" valign="top">204</td>
<td align="center" valign="top">CC</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message queue or program library name</td>
</tr>
<tr>
<td align="center" valign="top">214</td>
<td align="center" valign="top">D6</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Message destination</td>
</tr>
<tr>
<td align="center" valign="top">218</td>
<td align="center" valign="top">DA</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Volume list status</td>
</tr>
<tr>
<td align="center" valign="top">219</td>
<td align="center" valign="top">DB</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset of replacement text</td>
</tr>
<tr>
<td align="center" valign="top">223</td>
<td align="center" valign="top">DF</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of replacement text</td>
</tr>
<tr>
<td align="center" valign="top">227</td>
<td align="center" valign="top">E3</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Generated cartridge ID status</td>
</tr>
<tr>
<td align="center" valign="top">228</td>
<td align="center" valign="top">E4</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Sequence number change allowed</td>
</tr>
<tr>
<td align="center" valign="top">229</td>
<td align="center" valign="top">E5</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">End position</td>
</tr>
<tr>
<td align="center" valign="top">230</td>
<td align="center" valign="top">E6</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">File sequence number</td>
</tr>
<tr>
<td align="center" valign="top">240</td>
<td align="center" valign="top">F0</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Aggregate volume sequence number</td>
</tr>
<tr>
<td align="center" valign="top">250</td>
<td align="center" valign="top">FA</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Media library tape resource name</td>
</tr>
<tr>
<td align="center" valign="top">260</td>
<td align="center" valign="top">104</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Media library tape resource type</td>
</tr>
<tr>
<td align="center" valign="top">264</td>
<td align="center" valign="top">108</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Media library tape resource model</td>
</tr>
<tr>
<td align="center" valign="top">268</td>
<td align="center" valign="top">10C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Generated cartridge identifier</td>
</tr>
<tr>
<td align="center" valign="top">269</td>
<td align="center" valign="top">10D</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Session identifier</td>
</tr>
<tr>
<td align="center" valign="top">279</td>
<td align="center" valign="top">117</td>
<td align="left" valign="top">CHAR(150)</td>
<td align="left" valign="top">Cartridge densities</td>
</tr>
<tr>
<td align="center" valign="top">429</td>
<td align="center" valign="top">1AD</td>
<td align="left" valign="top">CHAR(26)</td>
<td align="left" valign="top">Qualified job name</td>
</tr>
<tr>
<td align="center" valign="top">455</td>
<td align="center" valign="top">1C7</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">459</td>
<td align="center" valign="top">1CB</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Type of close operation</td>
</tr>
<tr>
<td align="center" valign="top">460</td>
<td align="center" valign="top">1CC</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Command name</td>
</tr>
<tr>
<td align="center" valign="top">470</td>
<td align="center" valign="top">1D6</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Message recoverable flag</td>
</tr>
<tr>
<td align="center" valign="top">471</td>
<td align="center" valign="top">1D7</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Output extend processing</td>
</tr>
<tr>
<td align="center" valign="top">472</td>
<td align="center" valign="top">1D8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User sequence number</td>
</tr>
<tr>
<td align="center" valign="top">482</td>
<td align="center" valign="top">1E2</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">User expiration date</td>
</tr>
<tr>
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">488</td>
<td align="center" valign="top">1E8</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Virtual device<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">489</td>
<td align="center" valign="top">1E9</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">WORM cartridge<img src="deltaend.gif" alt="End of change"></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">Message replacement text (The offset to this
field is stored in the Offset of replacement text field)</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDROIFF">Field Descriptions</a></h3>
<p><strong>Aggregate volume sequence number.</strong> The aggregate volume
sequence number from the label information. The numeric value is
right-justified with leading zeros or blanks.</p>
<p><strong>Cartridge densities.</strong> The densities that are supported by
the cartridge. Up to 15 densities or formats are supported by the cartridge.
Each density or format is 10 characters in length. For example, if only one
density exists, the first 10 bytes of this field are the character
representation of the density or format and the last 140 bytes are blanks. This
field is set at the start-of-volume exit type and is blank at all other exit
types. This field is blank for devices or cartridges that do not support
special cartridge-checking capabilities.</p>
<p><strong>Cartridge identifier.</strong> The cartridge identifier of the tape
cartridge. If the tape library device has a scanner, the cartridge identifier
is the external bar-code identifier. If the tape library device does not have a
scanner, the cartridge identifier is the logical volume identifier. This field
is blank if the device is not in a tape library device or when the tape
position exit type field is SOF.</p>
<p><strong>Category name.</strong> The category name that the cartridge
identifier is being changed to. This field is blank if the tape library device
exit type field is not addition or category.</p>
<p><strong>Category system name.</strong> The category system name that is the
primary owner of the category name. This field is blank when the category is
*INSERT, *EJECT, or *SHARE400.</p>
<p><strong>Command name.</strong> The name of the command being run. If this
field is blanks, then the command does not support passing the command name to
the Media and Storage Extension structures at this exit point. Check Tape
(CHKTAP), Duplicate Tape (DUPTAP), and Initialize Tape (INZTAP) commands pass
the command name for all exit types.</p>
<p><strong>Current device name.</strong> The name of the tape device being used
at the time the exit point is reached. This field is blank if the tape library
device exit type field is addition, removal, or category.</p>
<p><strong>Current device type.</strong> The device type of the current tape
device. This field is blank if the tape library device exit type field is
addition, removal, or category.</p>
<p><strong>Current tape density.</strong> The density of the tape reel or
cartridge on the current tape device. This field is blank if the tape library
device exit type field is addition, removal, or category.</p>
<p><strong>Current volume identifier.</strong> The name of the expected volume
to be used during the tape operation, not necessarily the loaded volume. i5/OS
issues an inquiry message when the expected volume is different from the loaded
volume. This field is blank if the tape library device exit type field is
addition, removal, or category.</p>
<p><strong>Data check on write.</strong> Whether a permanent write data check
occurred. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">A permanent write data check has not
occurred.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A permanent write data check occurred and
end-of-volume labels are being written before the end of tape.</td>
</tr>
</table>
<p><strong>Data file label.</strong> The tape data file being processed. This
field is blank if the tape library device exit type field is addition, removal,
or category.</p>
<p><strong>End position.</strong> The type of end position that is occurring
for this close operation. This exit type is designed for applications that
track the end positioning of cartridges. It becomes important for media library
devices where *LEAVE ties up a device for that cartridge being left in leave
processing. This field is blank at all exit points other than the end position
exit type. Valid values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">*REWIND</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">*UNLOAD</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">*LEAVE</td>
</tr>
</table>
<p><strong>File sequence number.</strong> The file sequence number from the
label information.</p>
<p><strong>Generated cartridge identifier.</strong> Whether the cartridge
identifier is generated. Generated identifiers include BLKxxx (where xxx are
the characters 0-9) for blank or new tapes, IMPxxx for tapes in the convenience
(import) station, NLTxxx for nonstandard labeled tapes, CLNxxx for cleaning
tapes, and ERRxxx for tape cartridges in error. This field is blank when no
cartridge identifier is passed in the operational information format in the
cartridge identifier field. Valid 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 identifier is not generated.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The cartridge identifier is generated.</td>
</tr>
</table>
<p><strong>Generated cartridge ID status.</strong> Whether the media library
device has a bar-code reader. If the media library device does not have a
bar-code reader, then the field indicates if the cartridge identifiers are
generated by the system or if the logical volume identifiers are used as the
cartridge identifiers. This field is blank at all exit types except inventory
success exit. Valid 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 media library device has a bar-code
reader.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The media library device does not have a bar-code
reader, and the logical volume identifiers will be used as the cartridge
identifiers (that is, the device description has *VOLID specified for the
GENCTGID parameter).</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The media library device does not have a bar-code
reader, and the system will generate the cartridge identifiers (that is, the
device description has *SYSGEN for the GENCTGID parameter).</td>
</tr>
</table>
<p><strong>Initialize new volume label.</strong> Whether a new volume label
initializes immediately. This field is blank if the tape position exit type
field is not SOV. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">An SOV tape position exit type after the volume
label on tape is read</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">An SOV tape position exit type before the new
volume label is written</td>
</tr>
</table>
<p><strong>Length of control value information.</strong> The length, bytes, of
the control value information.</p>
<p><strong>Length of operational information.</strong> The length, in bytes, of
the operational information.</p>
<p><strong>Length of replacement text.</strong> The length, in bytes, of the
replacement text for the message exit type.</p>
<p><strong>Library device mode.</strong> Whether the library device is in
library mode. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The library device is not in library mode.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The library device is in library mode.</td>
</tr>
</table>
<p><strong>Library device name.</strong> The name of the tape library device
being used at the time the exit point is reached. This field is blank if a tape
library device is not being used.</p>
<p><strong>Library device status.</strong> Whether the device is in a library
device. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The tape device is not in a library device.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The tape device is in a library device.</td>
</tr>
</table>
<p><strong>Logical block identifier.</strong> The current tape position. This
refers to the logical position of the data buffer rather than the physical
position of the media. This field is passed as part of the SOS tape position
exit type for tapes that support positioning by logical block identifier on
standard labeled (*SL) tapes opened for output. This field is zero at all other
exit types.</p>
<p><strong>Media library tape resource name.</strong> For a media library
device, the resource name of the tape device being used. If no device is
allocated to the process for use, the field is blank.</p>
<p><strong>Media library tape resource model.</strong> The model number of the
tape resource name.</p>
<p><strong>Media library tape resource type.</strong> The type number of the
tape resource name.</p>
<p><strong>Message destination.</strong> The destination of the message to be
signalled by the operating system in relation to the program name specified in
the message queue or program name field. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>PREV</em></td>
<td align="left" valign="top">The message is sent to the program previous to
the one specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>SAME</em></td>
<td align="left" valign="top">The message is sent to the program
specified.</td>
</tr>
</table>
<p><strong>Message identifier.</strong> The identifier of the message that is
signalled.</p>
<p><strong>Message queue or program name.</strong> The name of the message
queue or program to which the message will be sent.</p>
<p><strong>Message queue or program library name.</strong> The name of the
library in which the message queue or program will reside.</p>
<p><strong>Message recoverable flag.</strong> Indicates if the message is
recoverable. This field is valid only for the message exit. It is blank for all
other exit types. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The message is not recoverable.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The message is recoverable.</td>
</tr>
</table>
<p><strong>Message replacement text.</strong> The replacement text for the
message identifier on the message exit type. The offset to this field and the
length of this field are also contained in the operational information
format.</p>
<p><strong>Message type.</strong> The type of message that will be signalled.
Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>ESCP</em></td>
<td align="left" valign="top">Escape message</td>
</tr>
<tr>
<td align="left" valign="top"><em>INQ</em></td>
<td align="left" valign="top">Inquiry message</td>
</tr>
</table>
<p><strong>Mismatch status.</strong> Whether a mismatch occurred when using the
Add Tape Cartridge (ADDTAPCTG) command. This field is blank if the tape library
device exit type is not mismatch or if the device is not in a tape library
device. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">A mismatch did not occur when using the
command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A mismatch occurred when using the command.</td>
</tr>
</table>
<p><strong>Next device name.</strong> The next device name in the list of
devices. If only one device has been specified, the current and next device
names are the same. This field is blank if the tape library device exit type is
addition, removal, or category.</p>
<p><strong>Next tape density.</strong> The new density when a reel or cartridge
is initialized. This field is blank if the tape library device exit type is
addition, removal, or category.</p>
<p><strong>Next volume identifier.</strong> The next volume label in the list
of labels. Blanks indicate that the volume identifier list is used up. This
field is blank if the tape library device exit type is addition, removal, or
category.</p>
<p><strong>Offset of replacement text.</strong> The offset, in bytes, of the
replacement text for the message exit type.</p>
<p><strong>Output extend processing.</strong> Indicates when a tape file is
opened for output with extend processing. This flag will only be set when a
tape file is opened for output. Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">The file is opened for input.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The file is opened for output.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The file is opened for output with extend
processing.</td>
</tr>
</table>
<p><strong>Qualified job name.</strong> The qualified job name that forced the
tape function and exit types.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Session identifier.</strong> An identifier to the tape management
system of the session identifier that is associated with this request. Each
session in a media library device has its own unique session identifier. An
exception is a mounted category request, which has a session identifier
assigned from the SETTAPCGY OPTION(*MOUNTED) to SETTAPCGY OPTION(*DEMOUNTED);
this session identifier is used for each command that specifies VOL(*MOUNTED)
while a category is mounted. This field is set to blanks for stand alone
devices.</p>
<p><strong>Sequence number change allowed.</strong> Whether the tape management
system is allowed to change the user-specified sequence number. Valid values
follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No change to the user-specified sequence number
value is allowed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No change to the user-specified sequence number
value is allowed because of the tape positioning or tape file status (that is,
end of volume).</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A change to the user-specified sequence number is
allowed. Valid sequence numbers include 1, *END, or one greater than the last
sequence number on the tape. This value is valid only for output
operations.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">A change to the user-specified sequence number is
allowed.
<p>For output operations, the valid new sequence number values include 1, any
existing sequence number, *END, or one greater than the last sequence number on
the tape.</p>
<p>For input operations, the valid new sequence number values include any
existing sequence number.</p>
</td>
</tr>
</table>
<p>When a change is allowed, the user-specified sequence number is placed in
both the sequence number and large sequence number fields of the control value
information. Either the sequence number or large sequence number fields of the
control value information may be changed to a new value by the tape management
system.</p>
<p><strong>Note:</strong> For user-specified sequence numbers greater than
999&nbsp;999, the value will appear only in the large sequence number
field.</p>
<p><strong>Note:</strong> The tape management system is not allowed to change
the user-specified sequence number for input operations for the CHKTAP, DMPTAP,
DSPTAP, and DUPTAP commands.</p>
<p><strong>System restricted state status.</strong> Whether the system is in
restricted state. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The system is not in a restricted state.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The system is in a restricted state.</td>
</tr>
</table>
<p><strong>Tape device file library name.</strong> The name of the library that
contains the tape device file. This field is blank if the tape library device
exit type is addition, removal, or category.</p>
<p><strong>Tape device file name.</strong> The name of the tape device file for
this tape device. This field is blank if the tape library device exit type is
addition, removal, or category.</p>
<p><strong>Tape device ready status.</strong> Whether the tape device is ready.
Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The tape device is not ready</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The tape device is ready</td>
</tr>
</table>
<p><strong>Tape operation.</strong> An indicator of how the tape file was
opened. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The tape file is open for input.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The tape file is open for output.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">No tape file is open.</td>
</tr>
</table>
<p><strong>Tape volume initialize status.</strong> The identifier that
determines the type of checking for active files during the initialize
operation. This field is blank when it is not an initialize operation. Valid
values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Initialize operation and check for active file is
*NO.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Initialize operation and check for active files
is *YES.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Initialize operation and check for active files
is *FIRST.</td>
</tr>
</table>
<p><strong>Tape volume write protection status.</strong> Whether the tape
volume in use is write-protected. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The tape volume is not write-protected.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The tape volume is write-protected.</td>
</tr>
</table>
<p><strong>Type of close operation.</strong> The type of close operation. If
the exit type is not an end-of-file exit type, the field is blank. Valid values
follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">Not an end-of-file exit type</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Temporary close (save or restore operation closes
between files)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Permanent close (operation has completed)</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Normal termination (operation is being ended
normally)</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Abnormal termination (operation is being ended
abnormally)</td>
</tr>
</table>
<p>
<strong>User expiration date.</strong> The expiration date specified by the
user when the tape file was opened.</p>
<p>This field uses the Julian format with a leading century digit. It is of the
form CYYDDD, where C represents the thousands and hundreds of the year value
(19 is blank, 20 is 0, and 21 is 1), YY represents the year (00-99), and DDD
represents the day of the year (001-366). For example, 1 February 1972 is
represented as '&nbsp;72032' and 1 February 2072 is represented as
'072032'.</p>
<p>The value *PERM indicates that the tape file is a permanent
tape file.</p>
<p>The user expiration date will be blanks when the file is open for input or if the
expiration date is *NONE.</p>
<p><strong>User sequence number.</strong> The sequence number specified by the
user when the tape file was opened. The sequence number will be blank when a
tape file is opened for accessing a tape device but no input/output operations
are to be issued or no sequence number is specified. Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*FIRST</em></td>
<td align="left" valign="top">First sequence on the tape (only valid for input)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NEXT</em></td>
<td align="left" valign="top">Next sequence on the tape (only valid for input)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*END</em></td>
<td align="left" valign="top">Append to end of the tape (only valid for output)</td>
</tr>
<tr>
<td align="left" valign="top"><em>number</em></td>
<td align="left" valign="top">The specified sequence on the tape (valid for input and output)</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change">
<strong>Virtual device.</strong> Indicates whether or not the device is a virtual device. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The device is not a virtual device.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The device is a virtual device.<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<p><strong>Volume list status.</strong> Whether *MOUNTED is specified for the
volume (VOL) parameter. This field is set at SOF and SOV. This field allows
tape management to control the monitoring of the Set Tape Category (SETTAPCGY)
command for occurrences of *MOUNTED specified for the VOL parameter. This field
is blank if the tape processing exit type is not start of file (SOF) and not
start of volume (SOV). Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">VOL(*MOUNTED) is not specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">VOL(*MOUNTED) is specified.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change"><strong>WORM cartridge</strong>
Specifies whether the current cartridge is a write-once-read-many (WORM) cartridge
or a read-write cartridge.
This field is valid when the tape processing exit type is start of volume (SOV),
start of file section (SOS), end of file section (EOS), or end of file (EOF).
It will be blank for all other exit types. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The current cartridge is a read-write cartridge.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The current cartridge is a write-once-read-many cartridge.<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCVIF2">Format of Control Value Information</a></h3>
<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(1)</td>
<td align="left" valign="top" width="60%">Volume acceptance</td>
</tr>
<tr>
<td align="center" valign="top">1</td>
<td align="center" valign="top">1</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Volume to be used</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="center" valign="top">7</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">File expiration date</td>
</tr>
<tr>
<td align="center" valign="top">13</td>
<td align="center" valign="top">D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Character code conversion</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="center" valign="top">E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow ignore response</td>
</tr>
<tr>
<td align="center" valign="top">15</td>
<td align="center" valign="top">F</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Issue active file messages</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Issue mount next tape message</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">Logical block identifier</td>
</tr>
<tr>
<td align="center" valign="top">49</td>
<td align="center" valign="top">31</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow category change</td>
</tr>
<tr>
<td align="center" valign="top">50</td>
<td align="center" valign="top">32</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow removal</td>
</tr>
<tr>
<td align="center" valign="top">51</td>
<td align="center" valign="top">33</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Mismatch acceptance</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Automatic ADDTAPCTG</td>
</tr>
<tr>
<td align="center" valign="top">53</td>
<td align="center" valign="top">35</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Message response</td>
</tr>
<tr>
<td align="center" valign="top">54</td>
<td align="center" valign="top">36</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow mount category</td>
</tr>
<tr>
<td align="center" valign="top">55</td>
<td align="center" valign="top">37</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow demount category</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Sequence number</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">Category name</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Category system name</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Large sequence number</td>
</tr>
<tr>
<td align="center" valign="top">90</td>
<td align="center" valign="top">5A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow logical block identifier support</td>
</tr>
<tr>
<td align="center" valign="top">91</td>
<td align="center" valign="top">5B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow cartridge search</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">End position</td>
</tr>
<tr>
<td align="center" valign="top">93</td>
<td align="center" valign="top">5D</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Density or format</td>
</tr>
<tr>
<td align="center" valign="top">103</td>
<td align="center" valign="top">67</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Use optimum block size</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Duplicate file</td>
</tr>
<tr>
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">105</td>
<td align="center" valign="top">69</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Image catalog name<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">115</td>
<td align="center" valign="top">73</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Suppress auto-generate of virtual tape volume<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCVIFT">Field Descriptions</a></h3>
<p>All of these control values have a default at the exit types in which the
exit program can change them. For exit types that values cannot be changed, the
values are set to blanks.</p>
<p><strong>Allow cartridge search.</strong> Whether to allow cartridge
searching for non-bar-code media library devices when the cartridge that is
specified in the VOL parameter of a command is not found. If the system is
allowed to use cartridge searching, the system loads tapes and searches for a
logical volume identifier to match the requested volume. The cartridges that
the system loads and searches are the cartridges with generated identifiers and
unknown logical volume identifiers. Cartridges with generated identifiers such
as NLTxxx (nonlabeled), BLKxxx (blank), or ERRxxx (error) are not used in
cartridge searching by the system.</p>
<p>If cartridge searching is allowed, the system may load and unload the
convenience station tape, which causes the tape to no longer be recognized by
the device. This field can only be changed at the start-of-file exit type. At
all other exit types, the default value is blank. Valid values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Disallow system cartridge searching</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Allow system cartridge searching</td>
</tr>
</table>
<p><strong>Allow category change.</strong> Whether to allow a change of
category for the cartridge identifier. You can change this value when the tape
library device exit type field is category. The default is 1 when the tape
library device exit type is category. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The category for the cartridge identifier cannot
be changed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The category for the cartridge identifier can be
changed.</td>
</tr>
</table>
<p><strong>Allow demount category.</strong> Whether to allow a demount
category. You can change this value when the tape library device exit type
field is demount category. The default is 1 when the tape library device exit
type is demount category. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Disallow the demount category operation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Allow the demount category operation.</td>
</tr>
</table>
<p><strong>Allow ignore response.</strong> Whether to allow an ignore response
to a mount message. If the field contains a value that is not valid, it is
ignored and message CPF4067 is issued. You can change the value when the tape
position exit type field is SOV. The default is 0 when the tape position exit
type is SOV. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">An ignore response is allowed from the mount next
tape messages. The ignore response is permitted as normal on the mount next
tape messages.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">An ignore response is not allowed from the mount
next tape messages.</td>
</tr>
</table>
<p><strong>Allow logical block identifier support.</strong> Whether to allow
logical block identifier support for this device. If a tape management system
responds at the start-of-file exit type, this value allows devices that do not
support logical block identifiers to work with i5/OS code. Devices that are
emulating i5/OS supported devices may not support logical block identifiers
but still report because of emulation that the device does support it. Valid
values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Disallow logical block identifier support.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Allow logical block identifier support.</td>
</tr>
</table>
<p><strong>Allow mount category.</strong> Whether to allow a mount category.
You can change this value when the tape library device exit type field is mount
category. The default is 1 when the tape library device exit type is mount
category. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Disallow the mount category operation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Allow the mount category operation.</td>
</tr>
</table>
<p><strong>Allow removal.</strong> Whether to allow the removal of the
cartridge identifier. You can change the value when the tape library device
exit type field is removal. The default is 1 when the tape library device exit
type is removal. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The cartridge identifier cannot be removed from
the tape library device.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The cartridge identifier can be removed from the
tape library device.</td>
</tr>
</table>
<p><strong>Automatic ADDTAPCTG.</strong> Whether to allow the tape management
system the ability to automatically add the cartridge to a usable category when
the exit type field is mount failure and the cartridge is currently in the
*INSERT category. (For more information about usable categories, see the Add
Tape Cartridge (ADDTAPCTG) command in the <a href="../rbam6/rbam6clmain.htm">
Control Language (CL)</a> topic.) You can change this value when the tape
library device exit type field is mount failure. The default is 0 when the tape
library device exit type is mount failure. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The cartridge identifier is not added to a usable
category.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The cartridge identifier is added to the *NOSHARE
category, and the tape processing continues.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The cartridge identifier is added to the
*SHARE400 category, and the tape processing continues.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The cartridge identifier is added to the *IPL
category, and the tape processing continues.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">The cartridge identifier is added to the *NL
category, and the tape processing continues.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">The cartridge identifier is added to the *CNV
category, and the tape processing continues.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">The cartridge identifier is added to the category
name and to the category system name fields that are specified in the control
value information format.</td>
</tr>
</table>
<p><strong>Category name.</strong> If a valid category name and category system
name are specified, the cartridge is changed to that category. This automatic
Change Tape Cartridge (CHGTAPCTG) command does not force a change exit type and
can only be specified for media library devices and at the start-of-volume exit
type. If you specify option 6 for the automatic tape cartridge field at the
mount failure exit type, this field is also allowed. The field is set to blanks
at all other exits types. You cannot change to the system-supplied categories
*CNV and *SYSGEN.</p>
<p><strong>Category system name.</strong> If you specify a valid category name
and category system name, the cartridge is changed to that category. This
automatic Change Tape Cartridge (CHGTAPCTG) command does not force a change
exit type and can only be specified for media library devices and at the
start-of-volume exit type. If you specify option 6 for the automatic tape
cartridge field at the mount failure exit type, this field is also allowed. The
field is set to blanks at all other exit types. You cannot change to the
system-supplied categories *CNV and *SYSGEN.</p>
<p><strong>Character code conversion.</strong> Whether to convert character
code from ASCII to EBCDIC for data written on the tape. If the field contains a
value that is not valid, it is ignored and message CPF4067 is issued. You can
change this value when the tape position exit type field is SOF and the tape
operation field is 1. The default is 0 when the tape position exit type is SOF
and the tape operation field is 1.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Convert ASCII data to EBCDIC data when processing
the data file</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Retain ASCII data</td>
</tr>
</table>
<p><strong>Density or format.</strong> This field allows the tape management
system to change the density or format of the tape volume. When the initialize
new volume label (operational information format) is set to 1, which indicates
that the new tape volume is written immediately, the user-specified density at
the start-of-volume exit type is used. The field must be set to one of the
valid cartridge densities that are listed in the operational information
format. The field is blank when it cannot be changed.</p>
<p><strong>Duplicate
File.</strong> This field allows the tape management system to select which
files are duplicated. You can change this value when the tape position exit
type field is SOS and the tape operation field is 0 for the DUPTAP command. The
default is to duplicate the file.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not duplicate the file</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Duplicate the file</td>
</tr>
</table>
<p><strong>End position.</strong> This field allows the tape management system
to change the end positioning that was specified by the user. The value can be
changed at the end positioning exit type. This field is blank when the value
cannot be changed. The default for this field is the value specified for end
positioning in the operational information format and can be changed to any of
the following:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Rewind the tape volume.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Unload the tape volume.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Do not position tape (*LEAVE).</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Unload and eject (remove) the tape volume.</td>
</tr>
</table>
<p><strong>File expiration date.</strong> The expiration date of the file being
written in the header label to control data file expiration.</p>
<p>This field uses the Julian format with a leading century digit. It is of the
form CYYDDD, where C represents the thousands and hundreds of the year value
(19 is blank, 20 is 0, and 21 is 1), YY represents the year (00-99), and DDD
represents the day of the year (001-366). For example, 1 February 1972 is
represented as '&nbsp;72032' and 1 February 2072 is represented as
'072032'.</p>
<p>The value *PERM indicates that the tape file is a permanent tape file. This
special value must be in uppercase and left-justified. Blanks indicate that the
default expiration date should be used.</p>
<p>You can change this value at SOF or SOV tape position exit type when the
tape operation field is 1 and the initialize new volume label field is 0.
(These fields are in the operational information format.) The default for this
field is the file expiration date that the user requested.</p>
<p>If the field is changed to contain a date that is not valid, it is ignored
and message CPF4063 is issued.</p>
<p><img src="delta.gif" alt="Start of change"><strong>Image catalog name.</strong>
The name of the currently loaded image catalog on the virtual device. This field can
be changed at any exit type along with setting the volume acceptance field to a value
of 4 to cause a replacement virtual tape image catalog to be loaded. If the tape position
exit type is SOF, SOV, or SOS, this field identifies a replacement for the current image
catalog. If the tape position exit type is EOS or EOF, this field identifies
a replacement for the next image catalog.</p>
<p>This field is always set to blank when the device is not a virtual device. If an
incorrect or unusable image catalog name is provided, or the device is not a virtual device,
message CPF41B0 will be issued. </p>
<p>The field is ignored during Duplicate Tape (DUPTAP) operations on all tape
position exit types except SOF, SOV, and SOS on the first source and first
target volumes.<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Issue active file messages.</strong> Whether i5/OS should issue
active file messages. If the field contains a value that is not valid, it is
ignored and message CPF4067 is issued. You can change the value when the tape
position exit type field is SOV. The default is 0 when the tape position exit
type is SOV. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Issue active file messages</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Do not issue active file messages</td>
</tr>
</table>
<p><strong>Issue mount next tape message.</strong> Whether i5/OS should issue
mount next tape messages. If the field contains a value that is not valid, it
is ignored and message CPF4067 is issued. You can change this value when the
tape position exit type field is EOS. The default is 0 when the tape position
exit type is EOS.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Mount next tape messages are issued.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Mount next tape messages are not issued.</td>
</tr>
</table>
<p><strong>Large sequence number.</strong> The sequence number being used. At
the start-of-volume exit type, this field contains the user-specified sequence
number. This field is blank for all other exit types. The field can be changed
for both input and output operations when the sequence number change allowed
field in the operational information indicates that a change is allowed.</p>
<p>For output operations, the following user-specified sequence numbers may be
passed to the tape management system:</p>
<ul>
<li>blank</li>
<li>*END (left-justified and padded with blanks)</li>
<li>A numeric value (right-justified with leading zeros or blanks) from 1 to
16&nbsp;777&nbsp;215</li>
</ul>
The sequence number may be changed to any of the following values:
<ul>
<li>blank</li>
<li>*END (left-justified and padded with blanks)</li>
<li>A numeric value (right-justified with leading zeros or blanks) from 1 to
16&nbsp;777&nbsp;215</li>
</ul>
<p>For input operations, the following user-specified sequence numbers may be
passed to the tape management system:</p>
<ul>
<li>blank</li>
<li>*FIRST (left-justified and padded with blanks)</li>
<li>*NEXT (left-justified and padded with blanks)</li>
<li>A numeric value (right-justified with leading zeros or blanks) from 1 to
16&nbsp;777&nbsp;215</li>
</ul>
The sequence number may be changed to any of the following values:
<ul>
<li>blank</li>
<li>A numeric value (right-justified with leading zeros or blanks) from 1 to
16&nbsp;777&nbsp;215</li>
</ul>
<p>An invalid value or changing the sequence number when it is not allowed
causes message CPF416B to be issued. This field overrides a value that is
specified for the sequence number field. This field has the same function as
the sequence number field, but allows for a greater range of sequence
numbers.</p>
<p><strong>Logical block identifier.</strong> The tape position to locate. This
field is checked after the SOV tape position exit type is reached. If the
logical block identifier is changed by the user at a tape position exit type
other than SOV, or is changed to an incorrect value, the logical block
identifier is referred to as an incorrect logical block identifier in message
CPD4076. The logical block identifier is an incorrect value for any of the
following:</p>
<ul>
<li>The tape is the wrong format</li>
<li>The tape is not a standard label (*SL) tape</li>
<li>The tape is not opened for input</li>
<li>The tape is opened for bypass label processing (*BLP)</li>
<li>The tape is opened for a read-backward operation</li>
<li>The device does not support positioning by logical block identifier</li>
<li>The identifier is not found on the tape</li>
</ul>
If the value specified is not a valid logical block ID, the value is ignored
and message CPD4076 is issued. If the value is ignored, the tape positioning is
done by sequence numbers. You can change this value at the SOV tape position
exit type. The default is 0 at the SOV tape position exit type.
<p><strong>Message response.</strong> The response to the message exit type.
You can change the value when the tape processing exit type is message. The
default is 0 when the tape processing exit point is message. If the message
response from the user is anything other than 0, a message that states that the
tape management system handled the error is sent to the user. Valid values are
as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Ignore the message exit type. The message is sent
when i5/OS regains control of the program from the user exit program.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Cancel the operation by replying to the message
exit type with a C before the message is actually sent. This stops the message
from being sent.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Ignore the operation by replying to the message
exit type with an I before the message is actually sent. This stops the message
from being sent.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Retry the operation by replying to the message
exit type with an R before the message is actually sent. This stops the message
from being sent.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Initialize the tape volume by replying to the
message exit type with an INZ before the message is actually sent. This stops
the message from being sent.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">
Continue the operation by replying to the message exit type with a G
before the message is actually sent.
This stops the message from being sent.
</td>
</tr>
</table>
<p><strong>Mismatch acceptance.</strong> The control value that determines how
to handle a cartridge ID mismatch situation. You can change the value when the
tape library device exit type field is mismatch. The default is 1 when the tape
library device exit type is mismatch. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Ignore the mismatch of the cartridge identifier
and the logical volume identifier.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Initialize the logical volume identifier to match
the cartridge identifier.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Eject the tape cartridge immediately from the
tape library device and place it in the *EJECT category. The tape operation
ends immediately.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Reject the output operation, leaving the tape
cartridge in the tape library device for input operations. The tape operation
ends immediately.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change"><strong>Suppress auto-generate of virtual tape volume.</strong> Whether to
suppress auto-generate of a new virtual tape volume. You can change this value
when the tape position exit type field is EOS. The default is 0 when the tape position exit
type is EOS. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Allow a new virtual tape volume to be auto-generated
when the end of the image catalog is reached.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Do not allow a new virtual tape volume to be
auto-generated when the end of the image catalog is reached.<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<p><strong>Sequence number.</strong> The sequence number to be used. Use the
large sequence number field rather than this field if you are adding support
for this function to a tape management system. At the start-of-volume exit
type, this field contains the user-specified sequence number. This field is
blank for all other exit types. The field can be changed for both input and
output operations when the sequence number change allowed field in the
operational information indicates that a change is allowed.</p>
<p>For output operations, the following user-specified sequence numbers may be
passed to the tape management system:</p>
<ul>
<li>blank</li>
<li>*END (left-justified and padded with blanks)</li>
<li>A numeric value (right-justified with leading zeros or blanks) from 1 to
999&nbsp;999</li>
</ul>
The sequence number may be changed to any of the following values:
<ul>
<li>blank</li>
<li>*END (left-justified and padded with blanks)</li>
<li>A numeric value (right-justified with leading zeros or blanks) from 1 to
999&nbsp;999</li>
</ul>
<p>For input operations, the following user-specified sequence numbers may be
passed to the tape management system:</p>
<ul>
<li>blank</li>
<li>*FIRST (left-justified and padded with blanks)</li>
<li>*NEXT (left-justified and padded with blanks)</li>
<li>A numeric value (right-justified with leading zeros or blanks) from 1 to
999&nbsp;999</li>
</ul>
The sequence number may be changed to any of the following values:
<ul>
<li>blank</li>
<li>A numeric value (right-justified with leading zeros or blanks) from 1 to
999&nbsp;999</li>
</ul>
<p>An invalid value or changing the sequence number when it is not allowed
causes message CPF416B to be issued. This field is ignored if a value is
specified for the large sequence number field.</p>
<p><strong>Use optimum block size.</strong> Whether to use the optimum block
size for save commands. If the optimum block size is used on a save command,
commands such as Duplicate Tape (DUPTAP) only duplicate the tape volume to
devices that support the same block size. If the optimum block size is not
used, normal save processing uses the default block size that can be duplicated
to any device type by using the DUPTAP command. The field is initialized to the
value that the user specifies on the save command. The field can be changed at
the start-of-command exit type only. At all other exit points, the field is set
to blanks. Note that if a blank is passed, the value cannot be overridden by
the tape management system. For example, on the Save System (SAVSYS) command,
the value specified by the user for Use Optimum Block (USEOPTBLK) cannot be
changed. Valid values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not use optimum block size</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Use optimum block size</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">An override is not allowed for optimum block
size</td>
</tr>
</table>
<p><strong>Volume acceptance.</strong> Whether the exit program accepts the
mounted volume <img src="delta.gif" alt="Start of change">or the loaded
virtual tape image catalog.<img src="deltaend.gif" alt="End of change">
This field has precedence over all other fields. You can change
this value when the tape position exit type field is 1 through 6. The default
is 1 for tape position exit types 1 through 5.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Mounted volume is accepted</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">No volume is accepted. The tape operation ends
immediately.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Reject in favor of another volume</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Reject and unload in favor of another volume
<img src="delta.gif" alt="Start of change">or in favor of another
virtual tape image catalog. When a new virtual tape image catalog is specified
a new virtual tape volume must also be provided.
<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<p>An acceptance value of '3' is not allowed when a category is mounted in a
tape library device. CPF410B, CPF450B, or CPF510B will be issued and the tape
operation ends immediately. An acceptance value of '4' is not allowed for a
tape position exit type of SOV when the Initialize new volume label field of
the Operational Information is set to '1'.<img src="delta.gif" alt="Start of change">
An acceptance value of '3' is not allowed when rejecting in favor of another virtual
tape image catalog.<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Volume to be used.</strong> The volume to be loaded if 3 or 4 is
specified for the volume acceptance field. This field can be set at any exit
type to pass a replacement volume identifier. If the tape position exit type is
SOF, SOV, or SOS, this field identifies a replacement for the current volume
identifier. If the tape position exit type is EOS or EOF, this field identifies
a replacement for the next volume identifier.</p>
<p>The field is ignored during Duplicate Tape (DUPTAP) operations on all tape
position exit types except SOF, SOV, and SOS on the first source and first
target volumes.</p>
<p>The field is used as a new volume identifier override during Initialize Tape
(INZTAP) operations.</p>
<p>The field must be set to blanks if 4 is specified for the volume acceptance
field when a category is mounted in a tape library device.</p>
<br>
<h3><a name="Header_242">Error Messages</a></h3>
<table width="100%" 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 align="left" valign="top" width="15%">CPD4003 D</td>
<td align="left" valign="top" width="85%">Alternate volume identifier not
standard.</td>
</tr>
<tr>
<td align="left" valign="top">CPD4076 D</td>
<td align="left" valign="top">Logical block identifier not correct.</td>
</tr>
<tr>
<td align="left" valign="top">CPF4062 D</td>
<td align="left" valign="top">Alternate volume identifier not standard.</td>
</tr>
<tr>
<td align="left" valign="top">CPF4063 D</td>
<td align="left" valign="top">Incorrect file expiration date &amp;7
specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF4067 D</td>
<td align="left" valign="top">Incorrect user exit control value specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF410A E</td>
<td align="left" valign="top">Error detected using program &amp;6 in
&amp;7.</td>
</tr>
<tr>
<td align="left" valign="top">CPF410B E</td>
<td align="left" valign="top">Volume acceptance response not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF410C E</td>
<td align="left" valign="top">End request specified by program &amp;6.</td>
</tr>
<tr>
<td align="left" valign="top">CPF416B E</td>
<td align="left" valign="top">Incorrect user exit control value specified.</td>
</tr>
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">CPF41B0 E</td>
<td align="left" valign="top">Incorrect image catalog name specified.<img src="deltaend.gif" alt="End of change">
</td>
</tr>
<tr>
<td align="left" valign="top">CPF4402 D</td>
<td align="left" valign="top">Alternate volume identifier not standard.</td>
</tr>
<tr>
<td align="left" valign="top">CPF450A E</td>
<td align="left" valign="top">Error detected using program &amp;6 in
&amp;7.</td>
</tr>
<tr>
<td align="left" valign="top">CPF450B E</td>
<td align="left" valign="top">Volume acceptance response not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF450C E</td>
<td align="left" valign="top">End request specified by program &amp;6.</td>
</tr>
<tr>
<td align="left" valign="top">CPF510A E</td>
<td align="left" valign="top">Error detected using program &amp;6 in
&amp;7.</td>
</tr>
<tr>
<td align="left" valign="top">CPF510B E</td>
<td align="left" valign="top">Volume acceptance response not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF510C E</td>
<td align="left" valign="top">End request specified by program &amp;6.</td>
</tr>
<tr>
<td align="left" valign="top">CPF5401 E</td>
<td align="left" valign="top">Interface error on device &amp;4.</td>
</tr>
</table>
<br>
<hr>
Exit program introduced: V3R1
<hr>
<center>
<table 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>
</center>
</body>
</html>
Reference in New Issue Copy Permalink