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

362 lines
15 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>Print Directory Information (PRTDIRINF)</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="PRTDIRINF.Top_Of_Page"></a>
<h2>Print Directory Information (PRTDIRINF)</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="#PRTDIRINF.PARAMETERS.TABLE">Parameters</a><br>
<a href="#PRTDIRINF.COMMAND.EXAMPLES">Examples</a><br>
<a href="#PRTDIRINF.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="PRTDIRINF"></a>
<p>The Print Directory Information (PRTDIRINF) command is used to print directory information for objects in the Integrated File System that was collected by the Retrieve Directory Information (RTVDIRINF) command. A spooled file with file name QPEZDIR goes to the spool queue associated with the job using this command.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must have all object (*ALLOBJ) special authority to run this command.
</li>
<li>Job CCSID value 65535 is not allowed.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="PRTDIRINF.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="#PRTDIRINF.RPTTYPE"><b>RPTTYPE</b></a></td>
<td valign="top">Type of report</td>
<td valign="top">*DIR, *OBJ, *OWN</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#PRTDIRINF.INFFILEPFX"><b>INFFILEPFX</b></a></td>
<td valign="top">Information file prefix</td>
<td valign="top"><i>Simple name</i>, <b><u>*LAST</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTDIRINF.INFLIB"><b>INFLIB</b></a></td>
<td valign="top">Information library</td>
<td valign="top"><i>Name</i>, <b><u>*LAST</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTDIRINF.OWNER"><b>OWNER</b></a></td>
<td valign="top">Owners</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTDIRINF.OBJ"><b>OBJ</b></a></td>
<td valign="top">Objects</td>
<td valign="top"><i>Path name</i>, <b><u>*ALL</u></b>, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTDIRINF.OBJTYPE"><b>OBJTYPE</b></a></td>
<td valign="top">Object types</td>
<td valign="top">Single values: <b><u>*ALL</u></b><br>Other values (up to 60 repetitions): *ALRTBL, *AUTL, *BLKSF, *BNDDIR, *CFGL, *CHTFMT, *CHRSF, *CLD, *CLS, *CMD, *CNNL, *COSD, *CRG, *CRQD, *CSI, *CSPMAP, *CSPTBL, *CTLD, *DDIR, *DEVD, *DIR, *DOC, *DSTMF, *DTAARA, *DTADCT, *DTAQ, *EDTD, *EXITRG, *FCT, *FIFO, *FILE, *FLR, *FNTRSC, *FNTTBL, *FORMDF, *FTR, *GSS, *IGCDCT, *IGCSRT, *IGCTBL, *IMGCLG, *IPXD, *JOBD, *JOBQ, *JOBSCD, *JRN, *JRNRCV, *LIB, *LIND, *LOCALE, *MBR, *MEDDFN, *MENU, *MGTCOL, *MODD, *MODULE, *MSGF, *MSGQ, *M36, *M36CFG, *NODGRP, *NODL, *NTBD, *NWID, *NWSD, *OUTQ, *OVL, *PAGDFN, *PAGSEG, *PDG, *PGM, *PNLGRP, *PRDAVL, *PRDDFN, *PRDLOD, *PSFCFG, *QMFORM, *QMQRY, *QRYDFN, *RCT, *SBSD, *SCHIDX, *SOCKET, *SPADCT, *SQLPKG, *SQLUDT, *SRVPGM, *SSND, *STMF, *SVRSTG, *SYMLNK, *S36, *TBL, *TIMZON, *USRIDX, *USRPRF, *USRQ, *USRSPC, *VLDL, *WSCST</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTDIRINF.SUBTREE"><b>SUBTREE</b></a></td>
<td valign="top">Directory subtree</td>
<td valign="top"><b><u>*ALL</u></b>, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTDIRINF.MINSIZE"><b>MINSIZE</b></a></td>
<td valign="top">Smallest size</td>
<td valign="top">0-99999, <b><u>0</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTDIRINF.SORT"><b>SORT</b></a></td>
<td valign="top">Sort by</td>
<td valign="top"><b><u>*SIZE</u></b>, *OWNER, *LSTCHG, *NAME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTDIRINF.INCPATH"><b>INCPATH</b></a></td>
<td valign="top">Include path names</td>
<td valign="top"><b><u>*ALL</u></b>, *NONE</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="PRTDIRINF.RPTTYPE"></a>
<h3>Type of report (RPTTYPE)</h3>
<p>Specifies the type of report to print.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b>*DIR</b></dt>
<dd>A report of space being used by each directory is printed. Information will include a total size for the outermost directory and all nested subdirectories. Information for each subdirectory will include the total of space for just the subdirectory and will not include space for objects in any directories contained in the subdirectory.
</dd>
<dt><b>*OBJ</b></dt>
<dd>A report of object information for files and directories is printed.
</dd>
<dt><b>*OWN</b></dt>
<dd>A report of the user profile (owner) information for files and directories is printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTDIRINF.INFFILEPFX"></a>
<h3>Information file prefix (INFFILEPFX)</h3>
<p>Specifies the file name prefix of the database files that were created by the Retrieve Directory Information (RTVDIRINF) command to store the retrieved directory information.
</p>
<dl>
<dt><b><u>*LAST</u></b></dt>
<dd>The database files created by the most recent invocation of the RTVDIRINF command will be used. Informational message CPI1E31 will be sent to the job log and will contain the name and library of the files used.
</dd>
<dt><b><i>information-file-prefix</i></b></dt>
<dd>Specify the same file prefix as was specified on a previous invocation of the RTVDIRINF command. The RTVDIRINF command created multiple database files to store the retrieved directory information. If a file prefix is specified, a value other than *LAST must be specified for the INFLIB parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTDIRINF.INFLIB"></a>
<h3>Information library (INFLIB)</h3>
<p>Specifies the library that contains the database files that were created by the Retrieve Directory Information (RTVDIRINF) command to store the retrieved directory information.
</p>
<dl>
<dt><b><u>*LAST</u></b></dt>
<dd>The library used by the most recent invocation of the RTVDIRINF command will be used to find the database files which contain the retrieved directory information. Informational message CPI1E31 will be sent to the job log and will contain the name and library of the files used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library that contains the database files created by a previous invocation of the RTVDIRINF command. If a library name is specified, a value other than *LAST must be specified for the INFFILEPFX parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTDIRINF.OWNER"></a>
<h3>Owners (OWNER)</h3>
<p>Specify the names of the owners (user profiles) of the objects to print information about.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>The report contains information about objects owned by any user profile.
</dd>
<dt><b><i>owner-name</i></b></dt>
<dd>Specify the user profile that owns the objects to print information about.
</dd>
<dt><b><i>generic-name</i></b></dt>
<dd>Specify the generic user profile that owns the objects to print information about. 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 user profiles with names that begin with the generic prefix.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTDIRINF.OBJ"></a>
<h3>Objects (OBJ)</h3>
<p>Specifies the names of the objects to print information about.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>If you specify an owner (OWNER parameter), all objects owned by the specified owner are included. If OWNER(*ALL) is specified, all objects are included in the report.
</dd>
<dt><b>*NONE</b></dt>
<dd>No detail object information is included in the report, just a total size of owned objects, if *NONE is specified for Object (OBJ) parameter and *OWN is specified for the Type of report (RPTTYPE) parameter.
</dd>
<dt><b><i>object-name</i></b></dt>
<dd>The object information is included only for the objects specified by the given name. If an owner is specified (OWNER parameter), only the objects meeting the owner criteria and that match the given name are included.
</dd>
<dt><b><i>generic-name</i></b></dt>
<dd>The object information is included only for the objects that match the specified generic name. 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. If an owner is specified (OWNER parameter), only the objects meeting the owner criteria and that match the given generic name are included.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTDIRINF.OBJTYPE"></a>
<h3>Object types (OBJTYPE)</h3>
<p>Specifies the object types to print information about. If the OWNER or OBJ parameters were specified with a value other than *ALL, the owner and object name criteria must also be met.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Information about objects of all types is printed.
</dd>
</dl>
<p><b>Other values (up to 60 repetitions)</b>
</p>
<dl>
<dt><b><i>object-type</i></b></dt>
<dd>Information about objects of the type(s) specified is printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTDIRINF.SUBTREE"></a>
<h3>Directory subtree (SUBTREE)</h3>
<p>Whether to print subdirectories statistics in the report or not.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Statistics are included for all subdirectories within the directory processed by the Retrieve Directory Information (RTVDIRINF) command.
</dd>
<dt><b>*NONE</b></dt>
<dd>Statistics are included only for objects in the directory processed by the Retrieve Directory Information (RTVDIRINF) command.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTDIRINF.MINSIZE"></a>
<h3>Smallest size (MINSIZE)</h3>
<p>Specifies the size of the smallest object to include.
</p>
<dl>
<dt><b><u>0</u></b></dt>
<dd>All objects are included regardless of size.
</dd>
<dt><b><i>size</i></b></dt>
<dd>Specify size in number of kilobytes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTDIRINF.SORT"></a>
<h3>Sort by (SORT)</h3>
<p>Specifies the order in which the information should be sorted.
</p>
<dl>
<dt><b><u>*SIZE</u></b></dt>
<dd>Information is sorted by object size, from largest to smallest.
</dd>
<dt><b>*OWNER</b></dt>
<dd>The information is sorted in alphabetical order by owner name.
</dd>
<dt><b>*LSTCHG</b></dt>
<dd>The information is sorted by last-change date with the oldest information first.
</dd>
<dt><b>*NAME</b></dt>
<dd>Information is sorted by object name, names are listed in alphabetical order.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTDIRINF.INCPATH"></a>
<h3>Include path names (INCPATH)</h3>
<p>Specifies if the report will include the path where the objects reside. If *NONE is specified for Object (OBJ) parameter and *OWN is specified for the Type of report (RPTTYPE) parameter, this parameter will be ignored.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Paths are included in the report.
</dd>
<dt><b>*NONE</b></dt>
<dd>Paths are not included in the report.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="PRTDIRINF.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Print Information, Grouped by Owner, for Most Recent RTVDIRINF </b>
</p>
<p>
<pre>
PRTDIRINF RPTTYPE(*OWN) INFFILEPFX(*LAST) INFLIB(*LAST)
OWNER(*ALL) OBJ(*ALL) OBJTYPE(*ALL) SORT(*SIZE)
</pre>
</p>
<p>This command prints an owner report from the database file created by the most recent invocation of the Retrieve Directory Information (RTVDIRINF) command. Information in the report will be included for all objects, grouped by their owner. The information is sorted by object size and sent to the printer file QPEZDIR.
</p>
<p><b>Example 2: Print a Directory Report</b>
</p>
<p>
<pre>
PRTDIRINF RPTTYPE(*DIR) INFFILEPFX(MYROOTDIR)
INFLIB(QUSRSYS) SUBTREE(*ALL)
</pre>
</p>
<p>This command prints a directory report from database file MYROOTDIRO and MYROOTDIRD created by a prior invocation of the Retrieve Directory Information (RTVDIRINF) command. If information was collected for subdirectories by the RTVDIRINF command, that information will be included in the directory report. The information is sent to the printer file QPEZDIR.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="PRTDIRINF.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF2110</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF1ED2</b></dt>
<dd>File &amp;1 is in use and cannot be accessed.
</dd>
<dt><b>CPF1ED5</b></dt>
<dd>File prefix &amp;1 or library &amp;2 not found in QAEZDBFILE.
</dd>
<dt><b>CPF1ED6</b></dt>
<dd>File &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF1ED9</b></dt>
<dd>Retrieved directory information not complete.
</dd>
<dt><b>CPF1EEC</b></dt>
<dd>Not authorized to file &amp;1.
</dd>
<dt><b>CPF1E99</b></dt>
<dd>Unexpected error occurred.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTDIRINF.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>