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

448 lines
16 KiB
HTML
Raw Normal View History

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">
<title>Delete Spooled File (DLTSPLF)</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="DLTSPLF.Top_Of_Page"></a>
<h2>Delete Spooled File (DLTSPLF)</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="#DLTSPLF.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DLTSPLF.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DLTSPLF.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DLTSPLF"></a>
<p>The Delete Spooled File (DLTSPLF) command is used to remove the specified spooled file from the output queue. If the spooled file is currently being produced on a device, it is immediately stopped and removed. Any data that has not been produced is lost.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DLTSPLF.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="#DLTSPLF.FILE"><b>FILE</b></a></td>
<td valign="top">Spooled file</td>
<td valign="top"><i>Name</i>, *SELECT</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="4"><a href="#DLTSPLF.JOB"><b>JOB</b></a></td>
<td valign="top">Job name</td>
<td valign="top">Single values: <b><u>*</u></b><br>Other values: <i>Qualified job name</i></td>
<td valign="top" rowspan="4">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Job name</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: User</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 3: Number</td>
<td valign="top">000000-999999</td>
</tr><tr>
<td valign="top"><a href="#DLTSPLF.SPLNBR"><b>SPLNBR</b></a></td>
<td valign="top">Spooled file number</td>
<td valign="top">1-999999, <b><u>*ONLY</u></b>, *LAST, *ANY</td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#DLTSPLF.JOBSYSNAME"><b>JOBSYSNAME</b></a></td>
<td valign="top">Job system name</td>
<td valign="top"><i>Name</i>, <b><u>*ONLY</u></b>, *CURRENT, *ANY</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DLTSPLF.CRTDATE"><b>CRTDATE</b></a></td>
<td valign="top">Spooled file created</td>
<td valign="top">Single values: <b><u>*ONLY</u></b>, *LAST<br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Creation date</td>
<td valign="top">
<i>Date</i></td>
</tr>
<tr>
<td valign="top">Element 2: Creation time</td>
<td valign="top">
<i>Time</i>, <b><u>*ONLY</u></b>, *LAST</td>
</tr>
<tr>
<td valign="top" rowspan="6"><a href="#DLTSPLF.SELECT"><b>SELECT</b></a></td>
<td valign="top">Select files for</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="6">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: User</td>
<td valign="top">
<i>Name</i>, <b><u>*CURRENT</u></b>, *ALL</td>
</tr>
<tr>
<td valign="top">Element 2: Print device</td>
<td valign="top">
<i>Name</i>, <b><u>*ALL</u></b>, *OUTQ</td>
</tr>
<tr>
<td valign="top">Element 3: Form type</td>
<td valign="top">
<i>Character value</i>, <b><u>*ALL</u></b>, *STD</td>
</tr>
<tr>
<td valign="top">Element 4: User data</td>
<td valign="top">
<i>Character value</i>, <b><u>*ALL</u></b></td>
</tr>
<tr>
<td valign="top">Element 5: ASP</td>
<td valign="top">
1-32, <b><u>*ALL</u></b>, *ASPDEV</td>
</tr>
<tr>
<td valign="top"><a href="#DLTSPLF.ASPDEV"><b>ASPDEV</b></a></td>
<td valign="top">ASP device</td>
<td valign="top"><i>Name</i>, <b><u>*</u></b>, *SYSBAS, *CURASPGRP</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DLTSPLF.FILE"></a>
<h3>Spooled file (FILE)</h3>
<p>Specifies the spooled file that is to be removed from the output queue.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b>*SELECT</b></dt>
<dd>All spooled files that meet the selection values specified on the <b>Select files for (SELECT)</b> parameter are deleted. This value is mutually exclusive with a value specified on the <b>Job name (JOB)</b> parameter, <b>Spooled file number (SPLNBR)</b> parameter, <b>Job system name (JOBSYSNAME)</b> parameter, or the <b>Spooled file created (CRTDATE)</b> parameter.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the spooled file that is to be removed from the system.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DLTSPLF.JOB"></a>
<h3>Job name (JOB)</h3>
<p>Specifies the name of the job that produced (or is producing) the spooled file that is removed from the output queue.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The job that issued this command produced the spooled file to be deleted.
</dd>
</dl>
<p><b>Qualifier 1: Job name</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the job that produced the file to be deleted.
</dd>
</dl>
<p><b>Qualifier 2: User</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the user name that identifies the user profile under which the job is run.
</dd>
</dl>
<p><b>Qualifier 3: Number</b>
</p>
<dl>
<dt><b><i>000000-999999</i></b></dt>
<dd>Specify the system-assigned job number of the job that produced the spooled file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DLTSPLF.SPLNBR"></a>
<h3>Spooled file number (SPLNBR)</h3>
<p>Specifies the number of the job's spooled file that is to be removed from the output queue.
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>Only one spooled file in the job has the specified file name; therefore, the number of the spooled file is not necessary.
</dd>
</dl>
<dl>
<dt><b>*LAST</b></dt>
<dd>The highest-numbered spooled file created for the job that has the specified file name is the file that is being deleted.
</dd>
</dl>
<dl>
<dt><b>*ANY</b></dt>
<dd>The spooled file number is not used to determine which spooled file is used. Use this value when the job system name parameter or the spooled file create date and time parameter is to take precedence over the spooled file number when selecting a spooled file.
</dd>
</dl>
<dl>
<dt><b><i>spooled-file-number</i></b></dt>
<dd>Specify the number of the spooled file with the specified file name that is being deleted.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DLTSPLF.JOBSYSNAME"></a>
<h3>Job system name (JOBSYSNAME)</h3>
<p>Specifies the name of the system where the job that created the spooled file (JOB parameter) ran. This parameter is considered after the job name, user name, job number, spooled file name, and spooled file number parameter requirements have been met.
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>There is one spooled file with the specified job name, user name, job number, spooled file name, spooled file number, and spooled file create date and time.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>The spooled file created on the current system with the specified job name, user name, job number, spooled file name, spooled file number, and create date and time is used.
</dd>
<dt><b>*ANY</b></dt>
<dd>The job system name is not used to determine which spooled file is used. Use this value when the spooled file create date and time parameter is to take precedence over the job system name when selecting a spooled file.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the system where the job that created the spooled file ran.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DLTSPLF.CRTDATE"></a>
<h3>Spooled file created (CRTDATE)</h3>
<p>Specifies the date and time the spooled file was created. This parameter is considered after the job name, user name, job number, spooled file name, spooled file number, and job system name parameter requirements have been met.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>There is one spooled file with the specified job name, user name, job number, spooled file name, spooled file number, and job system name.
</dd>
<dt><b>*LAST</b></dt>
<dd>The spooled file with the latest create date and time of the specified job name, user name, job number, spooled file name, spooled file number, and job system name is used.
</dd>
</dl>
<p><b>Element 1: Creation date</b>
</p>
<dl>
<dt><b><i>date</i></b></dt>
<dd>Specify the date the spooled file was created.
</dd>
</dl>
<p><b>Element 2: Creation time</b>
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>There is one spooled file with the specified job name, user name, job number, spooled file name, spooled file number, job system name, and spooled file create date.
</dd>
<dt><b>*LAST</b></dt>
<dd>The spooled file with the latest create time of the specified job name, user name, job number, spooled file name, spooled file number, job system name, and spooled file create date is used.
</dd>
<dt><b><i>time</i></b></dt>
<dd>Specify the time the spooled file was created.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DLTSPLF.SELECT"></a>
<h3>Select files for (SELECT)</h3>
<p>Specifies which group of files should be selected for deletion. Positional values can be specified to select the files: the user that created the file, the device that the file is queued for, the form type specified, the user data tag associated with the file, or the auxiliary storage pool the file is in. Only files that meet each of the values are selected.
</p>
<p><b>Element 1: User</b>
</p>
<dl>
<dt><b><u>*CURRENT</u></b></dt>
<dd>Only files created by the user running this command are selected.
</dd>
<dt><b>*ALL</b></dt>
<dd>Files created by all users are selected.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify a user name. Only files created by that user name are selected.
</dd>
</dl>
<p><b>Element 2: Print device</b>
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Files on any device-created or user-created output queue are selected.
</dd>
<dt><b>*OUTQ</b></dt>
<dd>All files on any user-created output queue are selected. A user-created output queue is any output queue that is not automatically created by a device. A user-created output queue does not generally have the same name as a device, but if it does, it does not reside in library QUSRSYS.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify a device name. Only files on the device created output queue for that device are selected. A device created output queue is one that has the same name as a device and resides in the QUSRSYS library. Unless it already exists, it will automatically be created by the system when the device is created. A device created output queue cannot be deleted.
</dd>
</dl>
<p><b>Element 3: Form type</b>
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Files for all form types are selected.
</dd>
<dt><b>*STD</b></dt>
<dd>Only files that specify the standard form type are selected.
</dd>
<dt><b><i>form-type</i></b></dt>
<dd>Specify the form type to select the file.
</dd>
</dl>
<p><b>Element 4: User data</b>
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Files with any user data tag specified are selected.
</dd>
<dt><b><i>user-data</i></b></dt>
<dd>Specify the user data tag to select the file.
</dd>
</dl>
<p><b>Element 5: ASP</b>
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All files as specified in the Auxiliary Storage Pool Device (ASPDEV) parameter are selected.
</dd>
<dt><b>*ASPDEV</b></dt>
<dd>Files specified in the Auxiliary Storage Pool Device (ASPDEV) parameter are selected.
</dd>
<dt><b><i>1-32</i></b></dt>
<dd>Specify the auxiliary storage pool (ASP) of the files being selected.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DLTSPLF.ASPDEV"></a>
<h3>ASP device (ASPDEV)</h3>
<p>Specifies the auxiliary storage pool device name from which spooled files are to be selected. This parameter is only valid if the ASP number (ASP) element of the Select parameter is *ALL or *ASPDEV.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>Files which are found in the ASPs that are currently part of the thread's library name space are selected. This includes the system ASP (ASP 1), all defined basic user ASPs (ASPs 2-32), and if the thread has an ASP group, the primary and secondary ASPs in the thread's ASP group.
</dd>
<dt><b>*SYSBAS</b></dt>
<dd>Files which are found in the system ASP (ASP 1) and all defined basic user ASPs (ASPs 2-32) are selected.
</dd>
<dt><b>*CURASPGRP</b></dt>
<dd>Files which are found in the primary and secondary ASPs in the thread's ASP group are selected. If no ASP group is associated with the thread, an error will be issued.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the auxiliary storage pool device description. Files which are found in the specified primary or secondary ASP are selected. Only primary or secondary ASPs which are in the thread's ASP group may be specified. If no ASP group is associated with the thread, an error will be issued.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DLTSPLF.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
DLTSPLF FILE(WEEKLY) JOB(000146/SMITH/PAYROLL5)
</pre>
</p>
<p>This command deletes the spooled file named WEEKLY (of job PAYROLL5, for user SMITH, job number 000146) from the output queue. Spooled files with different names produced by the job named PAYROLL5 are not affected by this command. If the job produced more than one file named WEEKLY, no file is deleted because SPLNBR(*ONLY) is assumed.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DLTSPLF.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF337E</b></dt>
<dd>ASP device &amp;1 not in current ASP group for thread.
</dd>
<dt><b>CPF337F</b></dt>
<dd>ASP device &amp;1 not allowed with ASP number &amp;2.
</dd>
<dt><b>CPF33D0</b></dt>
<dd>Printer &amp;1 does not exist.
</dd>
<dt><b>CPF33D1</b></dt>
<dd>User &amp;1 does not exist.
</dd>
<dt><b>CPF3303</b></dt>
<dd>File &amp;1 not found in job &amp;5/&amp;4/&amp;3.
</dd>
<dt><b>CPF3309</b></dt>
<dd>No files named &amp;1 are active.
</dd>
<dt><b>CPF3330</b></dt>
<dd>Necessary resource not available.
</dd>
<dt><b>CPF3340</b></dt>
<dd>More than one file with specified name found in job &amp;5/&amp;4/&amp;3.
</dd>
<dt><b>CPF3342</b></dt>
<dd>Job &amp;5/&amp;4/&amp;3 not found.
</dd>
<dt><b>CPF3343</b></dt>
<dd>Duplicate job names found.
</dd>
<dt><b>CPF3344</b></dt>
<dd>File &amp;1 number &amp;8 no longer in the system.
</dd>
<dt><b>CPF34A4</b></dt>
<dd>File &amp;1 number &amp;8 not held or deleted.
</dd>
<dt><b>CPF3478</b></dt>
<dd>File &amp;1 not found in job &amp;5/&amp;4/&amp;3 on output queue &amp;6 in library &amp;7.
</dd>
<dt><b>CPF3492</b></dt>
<dd>Not authorized to spooled file.
</dd>
<dt><b>CPF8128</b></dt>
<dd>&amp;8 damage on output queue &amp;4 in library &amp;9.
</dd>
<dt><b>CPF9825</b></dt>
<dd>Not authorized to device &amp;1.
</dd>
<dt><b>CPF9833</b></dt>
<dd>*CURASPGRP or *ASPGRPPRI specified and thread has no ASP group.
</dd>
<dt><b>CPFB8ED</b></dt>
<dd>Device description &amp;1 not correct for operation.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DLTSPLF.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>