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

468 lines
13 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>Work with Optical Files (WRKOPTF)</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="WRKOPTF.Top_Of_Page"></a>
<h2>Work with Optical Files (WRKOPTF)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>Interactive environments (*INTERACT *IPGM *IREXX *EXEC)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#WRKOPTF.PARAMETERS.TABLE">Parameters</a><br>
<a href="#WRKOPTF.COMMAND.EXAMPLES">Examples</a><br>
<a href="#WRKOPTF.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="WRKOPTF"></a>
<p>The Work with Optical Files (WRKOPTF) command displays a list of optical files on the system and provides options to copy, to delete, to rename and to display or print a list of optical files and their attributes.
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>To use this command you must have *USE authority to the authorization list securing the volume containing the optical files.
</li>
<li>If this command is issued for an optical volume which is in a remote optical server, only the following can be specified:
<ul>
<li>DIR(optical-directory-name)
</li>
<li>FILE(*ALL)
</li>
<li>FILE(file-name)
</li>
<li>FILE(generic*-file-name)
</li>
</ul>
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKOPTF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="WRKOPTF.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="#WRKOPTF.VOL"><b>VOL</b></a></td>
<td valign="top">Volume identifier</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#WRKOPTF.DIR"><b>DIR</b></a></td>
<td valign="top">Directory</td>
<td valign="top"><i>Character value</i>, *ALL</td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#WRKOPTF.FILE"><b>FILE</b></a></td>
<td valign="top">File</td>
<td valign="top"><i>Character value</i>, *SELECT, <b><u>*ALL</u></b></td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#WRKOPTF.SLTFILE"><b>SLTFILE</b></a></td>
<td valign="top">Select files</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: From file</td>
<td valign="top">
<i>Character value</i>, <b><u>*ALL</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: To file</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top" rowspan="8"><a href="#WRKOPTF.SLTDATE"><b>SLTDATE</b></a></td>
<td valign="top">Select date</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="8">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Date type</td>
<td valign="top">
<b><u>*CREATED</u></b>, *MODIFIED</td>
</tr>
<tr>
<td valign="top">Element 2: Starting date and time</td>
<td valign="top">
<i>Element list</i></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 1: Starting time</td>
<td valign="top">
<i>Time</i>, <b><u>*AVAIL</u></b></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 2: Starting date</td>
<td valign="top">
<i>Date</i>, <b><u>*BEGIN</u></b></td>
</tr>
<tr>
<td valign="top">Element 3: Ending date and time</td>
<td valign="top">
<i>Element list</i></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 1: Ending time</td>
<td valign="top">
<i>Time</i>, <b><u>*AVAIL</u></b></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 2: Ending date</td>
<td valign="top">
<i>Date</i>, <b><u>*END</u></b></td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#WRKOPTF.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="WRKOPTF.VOL"></a>
<h3>Volume identifier (VOL)</h3>
<p>Specifies the identifier of the optical volume that contains the files to be listed.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKOPTF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKOPTF.DIR"></a>
<h3>Directory (DIR)</h3>
<p>Specifies the optical directory that contains the files specified to be listed, beginning with the root directory of the volume.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>All directories on the specified optical volume are listed. If DIR(*ALL) is specified, only optical files contained in the root directory are listed.
</dd>
<dt><b><i>directory-name</i></b></dt>
<dd>Specify the name of a directory.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKOPTF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKOPTF.FILE"></a>
<h3>File (FILE)</h3>
<p>Specifies the file or files to be listed.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All files in the specified directory are listed.
</dd>
<dt><b>*SELECT</b></dt>
<dd>The files in the range specified on the SLTFILE parameter are listed.
<p>
<b>Note: </b>This value is ignored for volumes in remote optical servers.
</p>
</dd>
<dt><b><i>file-name</i></b></dt>
<dd>Specify the name of a file.
</dd>
<dt><b><i>generic*-file-name</i></b></dt>
<dd>Specify the generic name of the file you want to work with. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk substitutes for any valid characters. A generic name specifies all objects with names that begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKOPTF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKOPTF.SLTFILE"></a>
<h3>Select files (SLTFILE)</h3>
<p>Specifies the range of files to be listed.
</p>
<p><b>Notes:</b>
</p>
<ol>
<li>This parameter is valid only if FILE(*SELECT) is specified and is ignored if the optical volume was initialized as a backup volume.
</li>
<li>This parameter is not valid for remote optical servers.
</li>
</ol>
<p><b>Element 1: From file</b>
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All files in the specified directory are selected.
</dd>
<dt><b><i>from-file</i></b></dt>
<dd>Specify the name of the first file in the name range to be selected.
</dd>
<dt><b><i>generic*-file-name</i></b></dt>
<dd>Specify the generic name of the optical files to be selected.
</dd>
</dl>
<p><b>Element 2: To file</b>
</p>
<dl>
<dt><b><i>to-file</i></b></dt>
<dd>Specify the name of the last file in the name range.
<p>
<b>Note: </b>This value is ignored when the from-file value is *ALL or generic*.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKOPTF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKOPTF.SLTDATE"></a>
<h3>Select date (SLTDATE)</h3>
<p>Specifies the date and the time range of the files to be selected.
</p>
<p><b>Notes:</b>
</p>
<ol>
<li>This parameter is valid only if FILE(*SELECT) is specified and is ignored if the optical volume was initialized as a backup volume.
</li>
<li>This parameter is not valid for remote optical servers.
</li>
</ol>
<p><b>Element 1: Date type</b>
</p>
<dl>
<dt><b><u>*CREATED</u></b></dt>
<dd>The files are selected by the dates on which they were created.
</dd>
<dt><b>*MODIFIED</b></dt>
<dd>The files are selected by the dates on which they were changed.
</dd>
</dl>
<p><b>Element 2: Starting date and time</b>
</p>
<dl>
<dt><b></b></dt>
<dd>
<p><b>Element 1: Starting time</b>
</p>
<dl>
<dt><b><u>*AVAIL</u></b></dt>
<dd>The time range includes all possible times before the end time.
</dd>
<dt><b><i>start-time</i></b></dt>
<dd>Specify the earliest time in the time range.
</dd>
</dl>
</dd>
<dt><b></b></dt>
<dd>
<p><b>Element 2: Starting date</b>
</p>
<dl>
<dt><b><u>*BEGIN</u></b></dt>
<dd>The date of the oldest file is the starting date.
</dd>
<dt><b><i>start-date</i></b></dt>
<dd>Specify the earliest date in the date range.
</dd>
</dl>
</dd>
</dl>
<p><b>Element 3: Ending date and time</b>
</p>
<dl>
<dt><b></b></dt>
<dd>
<p><b>Element 1: Ending time</b>
</p>
<dl>
<dt><b><u>*AVAIL</u></b></dt>
<dd>The time range includes all times after the starting time.
</dd>
<dt><b><i>end-time</i></b></dt>
<dd>Specify the last time in the time range.
</dd>
</dl>
</dd>
<dt><b></b></dt>
<dd>
<p><b>Element 2: Ending date</b>
</p>
<dl>
<dt><b><u>*END</u></b></dt>
<dd>The date of the newest file is the ending date.
</dd>
<dt><b><i>end-date</i></b></dt>
<dd>Specify the last date in the date range.
</dd>
</dl>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKOPTF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKOPTF.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Displaying Optical Files in a Root Directory</b>
</p>
<p>
<pre>
WRKOPTF VOL(VOL01) DIR(*ALL)
</pre>
</p>
<p>This command displays a list of all optical files in the root directory on the optical volume VOL01.
</p>
<p><b>Example 2: Displaying Optical Files in a Specific Directory</b>
</p>
<p>
<pre>
WRKOPTF VOL(VOL02) DIR('/DIR1') FILE(*ALL)
</pre>
</p>
<p>This command displays a list of all optical files in the directory DIR1 on the optical volume VOL02.
</p>
<p><b>Example 3: Displaying Optical Files Created on Specific Dates</b>
</p>
<p>
<pre>
WRKOPTF VOL(VOL03) DIR('/DIR2')
FILE(*SELECT) SLTFILE(*ALL)
SLTDATE(*CREATED ('12:01:00' '1/1/94')
('23:59:59' '12/31/94'))
</pre>
</p>
<p>This command displays a list of all optical files in the directory DIR2 on the volume VOL03 created between 12:01:00 on January 1, 1994 and 23:59:59 on December 31, 1994.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKOPTF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKOPTF.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>OPT0159</b></dt>
<dd>Beginning selection is greater then ending selection.
</dd>
<dt><b>OPT1115</b></dt>
<dd>File not found.
</dd>
<dt><b>OPT1205</b></dt>
<dd>Directory not found.
</dd>
<dt><b>OPT1212</b></dt>
<dd>Directory in use.
</dd>
<dt><b>OPT1220</b></dt>
<dd>File or directory name already exists.
</dd>
<dt><b>OPT1224</b></dt>
<dd>Path length exceeds the maximum of 256 bytes.
</dd>
<dt><b>OPT1317</b></dt>
<dd>Directory name is too long.
</dd>
<dt><b>OPT1320</b></dt>
<dd>Optical volume &amp;1 in use.
</dd>
<dt><b>OPT1325</b></dt>
<dd>Optical volume format not recognized.
</dd>
<dt><b>OPT1330</b></dt>
<dd>Optical volume not found or not useable.
</dd>
<dt><b>OPT1331</b></dt>
<dd>Optical volume &amp;1 not found.
</dd>
<dt><b>OPT1340</b></dt>
<dd>Optical volume &amp;1 not initialized.
</dd>
<dt><b>OPT1360</b></dt>
<dd>Media directory corrupted on optical volume &amp;1.
</dd>
<dt><b>OPT1460</b></dt>
<dd>Optical volume &amp;1 is not in an optical device.
</dd>
<dt><b>OPT1463</b></dt>
<dd>Operation not completed, optical volume is not a primary volume.
</dd>
<dt><b>OPT1489</b></dt>
<dd>Volume parameter is not permitted for device &amp;1.
</dd>
<dt><b>OPT1530</b></dt>
<dd>&amp;1 does not represent a valid optical device.
</dd>
<dt><b>OPT1555</b></dt>
<dd>Optical device &amp;1 in use.
</dd>
<dt><b>OPT1605</b></dt>
<dd>Media or device error occurred.
</dd>
<dt><b>OPT1640</b></dt>
<dd>Error occurred reading files or directories.
</dd>
<dt><b>OPT1790</b></dt>
<dd>Operation not allowed or conflicts with another request.
</dd>
<dt><b>OPT1805</b></dt>
<dd>Error accessing optical volume index file.
</dd>
<dt><b>OPT1810</b></dt>
<dd>Error accessing optical directory index file.
</dd>
<dt><b>OPT1815</b></dt>
<dd>Internal program error occurred.
</dd>
<dt><b>OPT1820</b></dt>
<dd>Internal error occurred on optical device &amp;1.
</dd>
<dt><b>OPT1821</b></dt>
<dd>Error occurred on optical device &amp;1.
</dd>
<dt><b>OPT1825</b></dt>
<dd>Optical indexes are incorrect for optical device &amp;1.
</dd>
<dt><b>OPT1860</b></dt>
<dd>Request to optical device &amp;1 failed.
</dd>
<dt><b>OPT1861</b></dt>
<dd>No device description configured for resource &amp;1.
</dd>
<dt><b>OPT1862</b></dt>
<dd>No active device description for resource &amp;1.
</dd>
<dt><b>OPT1863</b></dt>
<dd>Optical libraries need to be reclaimed.
</dd>
<dt><b>OPT1872</b></dt>
<dd>Optical request timed out or was cancelled.
</dd>
<dt><b>OPT2301</b></dt>
<dd>Internal system object in use.
</dd>
<dt><b>OPT7740</b></dt>
<dd>User not authorized to object &amp;2 in library &amp;3 type &amp;4.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKOPTF.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>