ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/dsptap.htm

424 lines
15 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Display Tape (DSPTAP)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="DSPTAP.Top_Of_Page"></a>
<h2>Display Tape (DSPTAP)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#DSPTAP.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DSPTAP.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DSPTAP.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DSPTAP"></a>
<p>The Display Tape (DSPTAP) command shows the volume label and data file label information that is contained on a standard labeled magnetic tape or the volume type and density. The information can be printed or shown on a display device. Additional information, including a description of each object saved to the tape file and summary information about the saved objects, can be displayed by specifying *SAVRST on the <b>Data type</b> prompt (DATA parameter).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DSPTAP.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#DSPTAP.DEV"><b>DEV</b></a></td>
<td valign="top">Device</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#DSPTAP.VOL"><b>VOL</b></a></td>
<td valign="top">Volume identifier</td>
<td valign="top"><i>Character value</i>, <b><u>*MOUNTED</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPTAP.LABEL"><b>LABEL</b></a></td>
<td valign="top">File label</td>
<td valign="top"><i>Character value</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DSPTAP.SEQNBR"><b>SEQNBR</b></a></td>
<td valign="top">Sequence number</td>
<td valign="top">Single values: *ALL<br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Starting file sequence number</td>
<td valign="top">
1-16777215, <b><u>*FIRST</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Ending file sequence number</td>
<td valign="top">
1-16777215, *ONLY, <b><u>*LAST</u></b></td>
</tr>
<tr>
<td valign="top"><a href="#DSPTAP.DATA"><b>DATA</b></a></td>
<td valign="top">Data type</td>
<td valign="top"><b><u>*LABELS</u></b>, *SAVRST</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPTAP.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT, *OUTFILE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPTAP.ENDOPT"><b>ENDOPT</b></a></td>
<td valign="top">End of tape option</td>
<td valign="top"><b><u>*REWIND</u></b>, *UNLOAD</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DSPTAP.OUTFILE"><b>OUTFILE</b></a></td>
<td valign="top">File to receive output</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: File to receive output</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#DSPTAP.OUTMBR"><b>OUTMBR</b></a></td>
<td valign="top">Output member options</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Member to receive output</td>
<td valign="top">
<i>Name</i>, <b><u>*FIRST</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Replace or add records</td>
<td valign="top">
<b><u>*REPLACE</u></b>, *ADD</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DSPTAP.DEV"></a>
<h3>Device (DEV)</h3>
<p>Specifies the name of the tape or media library device in which the volume being shown is placed.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPTAP.VOL"></a>
<h3>Volume identifier (VOL)</h3>
<p>Specifies the tape volume to be displayed.
</p>
<p>
<b>Note: </b>If the device specified is a media library device, or a virtual tape device, then the volume specified should be the cartridge identifier or virtual volume name to be mounted and used.
</p>
<dl>
<dt><b><u>*MOUNTED</u></b></dt>
<dd>The volume currently placed in the device is used. For a media library device, the volume to be used is the next cartridge in the category mounted by the Set Tape Category (SETTAPCGY) command. For a virtual tape device, the volume to be used is the currently mounted one, or if there is not a currently mounted volume, the next volume in loaded status in the image catalog will be used.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the volume identifier of the labeled volume. The volume identifier read from the tape is compared to this value. If the volume identifier specified is not found on the tape, an escape message is sent.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPTAP.LABEL"></a>
<h3>File label (LABEL)</h3>
<p>Specifies the data file identifiers of the data files on the tape whose labels are shown. The data file identifier is stored in the label ahead of the data in the file.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All data file identifiers on the tape specified on the <b>Tape device</b> prompt (DEV parameter) are shown.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the data file identifier (17 alphanumeric characters maximum) of the data file for which label information is shown.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPTAP.SEQNBR"></a>
<h3>Sequence number (SEQNBR)</h3>
<p>Specifies, for volumes with multiple files, the range of sequence numbers of the data files on tape whose label information is displayed. If *ALL is specified on the <b>File label</b> prompt (LABEL parameter), all labels for the files within the specified sequence number range are displayed after the specified starting file sequence number.
</p>
<p>If a specific LABEL identifier is specified, it is compared with the label identifier of the data file specified by the starting sequence number. If the identifiers do not match, an error message is sent.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>All data file labels on the tape are displayed.
</dd>
</dl>
<p><b>Element 1: Starting file sequence number</b>
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The data file labels being displayed begin with the first file (or the only file) on the tape.
</dd>
<dt><b><i>1-16777215</i></b></dt>
<dd>Specify the starting file sequence number. If the specified starting file sequence number is not found on the tape, an error message is sent.
</dd>
</dl>
<p><b>Element 2: Ending file sequence number</b>
</p>
<dl>
<dt><b><u>*LAST</u></b></dt>
<dd>The range of data file labels being displayed begins with the specified starting file sequence number and ends with the last data file label on tape.
</dd>
<dt><b>*ONLY</b></dt>
<dd>Only the file specified in the starting sequence is displayed.
</dd>
<dt><b><i>1-16777215</i></b></dt>
<dd>Specify the ending file sequence number. The specified ending file sequence number must be greater than or equal to the starting file sequence number.
<p>
<b>Note: </b>The ending file sequence number is ignored for OUTPUT(*) for an interactive job. The user has control and can continue to display information or end whenever they desire.
</p>
<p>
<b>Note: </b>The ending file sequence number is ignored if a specific LABEL identifier is specified.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPTAP.DATA"></a>
<h3>Data type (DATA)</h3>
<p>Specifies the type of information that is shown.
</p>
<dl>
<dt><b><u>*LABELS</u></b></dt>
<dd>The volume label and data file labels are shown.
</dd>
<dt><b>*SAVRST</b></dt>
<dd>Shows the summary information about the command and each saved object.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPTAP.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether the output from the command is displayed at the requesting work station or printed with the job's spooled output.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The output is displayed (if requested by an interactive job) or printed with the job's spooled output (if requested by a batch job).
</dd>
</dl>
<dl>
<dt><b>*PRINT</b></dt>
<dd>The output is printed with the job's spooled output.
</dd>
</dl>
<dl>
<dt><b>*OUTFILE</b></dt>
<dd>The output is directed to the database file specified on the OUTFILE parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPTAP.ENDOPT"></a>
<h3>End of tape option (ENDOPT)</h3>
<p>Specifies the operation that is automatically performed on the tape volume after the operation ends. If more than one volume is included, this parameter applies only to the last tape volume used; all other tape volumes are rewound and unloaded when the end of the tape is reached.
</p>
<dl>
<dt><b><u>*REWIND</u></b></dt>
<dd>The tape is automatically rewound, but not unloaded, after the operation has ended.
</dd>
<dt><b>*UNLOAD</b></dt>
<dd>The tape is automatically rewound and unloaded after the operation ends.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPTAP.OUTFILE"></a>
<h3>File to receive output (OUTFILE)</h3>
<p>Specifies the qualified name of the database file to which the information about the tape files is directed. If the file does not exist, this command creates a database file in the specified library. If a new file is created, the system uses QATADOF in QSYS as a model with the format name of QTADOUTF.
</p>
<p>
<b>Note: </b>This parameter is valid only when OUTPUT(*OUTFILE) and DATA(*LABELS) is specified.
</p>
<p><b>Qualifier 1: File to receive output</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the database file to be used.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPTAP.OUTMBR"></a>
<h3>Output member options (OUTMBR)</h3>
<p>Specifies the name of the database file member to which the output is directed when OUTPUT(*OUTFILE) is specified.
</p>
<p><b>Element 1: Member to receive output</b>
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member in the file receives the output. If OUTMBR(*FIRST) is specified and the member does not exist, the system creates a member with the name of the file specified on the OUTFILE parameter.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the file member that is to receive the output. If a member name is specified and the member does not exist, the system creates it.
</dd>
</dl>
<p><b>Element 2: Replace or add records</b>
</p>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The existing records in the specified database file member are replaced by the new records.
</dd>
<dt><b>*ADD</b></dt>
<dd>The system adds the new records at the end of the existing member.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPTAP.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
DSPTAP DEV(QTAPE2) LABEL(*ALL)
</pre>
</p>
<p>This command displays the volume label and file labels on the tape volume that is on the tape device named QTAPE2.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPTAP.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPD375A</b></dt>
<dd>Media error on save media.
</dd>
<dt><b>CPF3704</b></dt>
<dd>Request ended; data management error occurred.
</dd>
<dt><b>CPF3743</b></dt>
<dd>File cannot be restored, displayed, or listed.
</dd>
<dt><b>CPF3792</b></dt>
<dd>Information not displayed. Error occurred.
</dd>
<dt><b>CPF3793</b></dt>
<dd>Machine or ASP storage limit reached.
</dd>
<dt><b>CPF6708</b></dt>
<dd>Command ended due to error.
</dd>
<dt><b>CPF6718</b></dt>
<dd>Cannot allocate device &amp;1.
</dd>
<dt><b>CPF6721</b></dt>
<dd>Device &amp;1 not a tape device.
</dd>
<dt><b>CPF6723</b></dt>
<dd>File not found on volume &amp;2 on device &amp;1.
</dd>
<dt><b>CPF6724</b></dt>
<dd>File label &amp;5 not found on volume &amp;2.
</dd>
<dt><b>CPF6745</b></dt>
<dd>Device &amp;1 not a media library device.
</dd>
<dt><b>CPF6751</b></dt>
<dd>Load failure occurred on device &amp;4.
</dd>
<dt><b>CPF6760</b></dt>
<dd>Device &amp;1 not ready.
</dd>
<dt><b>CPF6772</b></dt>
<dd>Volume on device &amp;1 cannot be processed.
</dd>
<dt><b>CPF9814</b></dt>
<dd>Device &amp;1 not found.
</dd>
<dt><b>CPF9825</b></dt>
<dd>Not authorized to device &amp;1.
</dd>
<dt><b>CPF9845</b></dt>
<dd>Error occurred while opening file &amp;1.
</dd>
<dt><b>CPF9846</b></dt>
<dd>Error while processing file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9847</b></dt>
<dd>Error occurred while closing file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9850</b></dt>
<dd>Override of printer file &amp;1 not allowed.
</dd>
<dt><b>CPF9851</b></dt>
<dd>Overflow value for file &amp;1 in &amp;2 too small.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPTAP.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>