393 lines
14 KiB
HTML
393 lines
14 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>Retrieve DLO Name (RTVDLONAM)</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="RTVDLONAM.Top_Of_Page"></a>
|
|
<h2>Retrieve DLO Name (RTVDLONAM)</h2>
|
|
<table width="100%">
|
|
<tr>
|
|
<td valign="top" align="left"><b>Where allowed to run: </b>Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX)<br>
|
|
<b>Threadsafe: </b>No
|
|
</td>
|
|
<td valign="top" align="right">
|
|
<a href="#RTVDLONAM.PARAMETERS.TABLE">Parameters</a><br>
|
|
<a href="#RTVDLONAM.COMMAND.EXAMPLES">Examples</a><br>
|
|
<a href="#RTVDLONAM.ERROR.MESSAGES">Error messages</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<div> <a name="RTVDLONAM"></a>
|
|
<p>The Retrieve Document Library Object Name (RTVDLONAM) command is used to retrieve an alternate name for a filed document, folder, or distribution document and place the value into the specified variables. This command is valid only within a CL program or REXX exec.
|
|
</p>
|
|
<p><b>Restrictions:</b>
|
|
</p>
|
|
<ul>
|
|
<li>A user must have use (*USE) authority to the filed document or folder to retrieve the various forms of the name.
|
|
</li>
|
|
<li>A user must have all object (*ALLOBJ) special authority to retrieve the various forms of the name for a distribution document.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
|
|
<div>
|
|
<h3><a name="RTVDLONAM.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="#RTVDLONAM.DLO"><b>DLO</b></a></td>
|
|
<td valign="top">Document library object</td>
|
|
<td valign="top"><i>Character value</i>, *DOCID, *LADNTSP, *SYSOBJNAM</td>
|
|
<td valign="top">Required, Positional 1</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.FLR"><b>FLR</b></a></td>
|
|
<td valign="top">Folder</td>
|
|
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
|
|
<td valign="top">Optional, Positional 2</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.DOCID"><b>DOCID</b></a></td>
|
|
<td valign="top">Document identifier</td>
|
|
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.LADNTSP"><b>LADNTSP</b></a></td>
|
|
<td valign="top">LADN timestamp</td>
|
|
<td valign="top">0000000000000001-FFFFFFFFFFFFFFFF, <b><u>*NONE</u></b></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.SYSOBJNAM"><b>SYSOBJNAM</b></a></td>
|
|
<td valign="top">System object name</td>
|
|
<td valign="top"><i>Name</i>, <b><u>*NONE</u></b></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.OBJCLS"><b>OBJCLS</b></a></td>
|
|
<td valign="top">Object class</td>
|
|
<td valign="top"><b><u>*DOC</u></b>, *FLR, *DST</td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.RTNDLO"><b>RTNDLO</b></a></td>
|
|
<td valign="top">CL var for RTNDLO (12)</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.RTNFLR"><b>RTNFLR</b></a></td>
|
|
<td valign="top">CL var for RTNFLR (63)</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.RTNDOCID"><b>RTNDOCID</b></a></td>
|
|
<td valign="top">CL var for RTNDOCID (24)</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.RTNLADNTSP"><b>RTNLADNTSP</b></a></td>
|
|
<td valign="top">CL var for RTNLADNTSP (16)</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.RTNOBJNAM"><b>RTNOBJNAM</b></a></td>
|
|
<td valign="top">CL var for RTNOBJNAM (10)</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.RTNOBJCLS"><b>RTNOBJCLS</b></a></td>
|
|
<td valign="top">CL var for RTNOBJCLS (8)</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.RTNASP"><b>RTNASP</b></a></td>
|
|
<td valign="top">CL var for RTNASP (2 0)</td>
|
|
<td valign="top"><i>Decimal number</i></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#RTVDLONAM.RTNOVRFLW"><b>RTNOVRFLW</b></a></td>
|
|
<td valign="top">CL var for RTNOVRFLW (1)</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</div>
|
|
<div> <a name="RTVDLONAM.DLO"></a>
|
|
<h3>Document library object (DLO)</h3>
|
|
<p>Specifies the document or folder for which a name is to be retrieved.
|
|
</p>
|
|
<p>This is a required parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b>*DOCID</b></dt>
|
|
<dd>The document or folder is identified using its library-assigned document name specified in the DOCID parameter. The <b>Folder (FLR)</b> parameter must be *NONE.
|
|
</dd>
|
|
<dt><b>*LADNTSP</b></dt>
|
|
<dd>The document or folder is identified using its library-assigned document name (LADN) timestamp specified in the LADNTSP parameter. The FLR parameter must be *NONE.
|
|
</dd>
|
|
<dt><b>*SYSOBJNAM</b></dt>
|
|
<dd>The document or folder is identified using its system object name specified in the SYSOBJNAM parameter. The FLR parameter must be *NONE.
|
|
</dd>
|
|
<dt><b><i>name</i></b></dt>
|
|
<dd>Specify the user-assigned name of the document or folder. The folder containing the specified document or folder is specified in the FLR parameter.
|
|
</dd>
|
|
</dl>
|
|
<p>This is a required parameter.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.FLR"></a>
|
|
<h3>Folder (FLR)</h3>
|
|
<p>Specifies the folder path that contains the document or folder specified in the <b>Document library object (DLO)</b> parameter. The FLR parameter must be *NONE if the DLO parameter is *DOCID, *LADNTSP, or *SYSOBJNAM.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*NONE</u></b></dt>
|
|
<dd>The document or folder is not contained in a folder, or is identified using the <b>DOCID</b>, <b>LADNTSP</b>, or <b>SYSOBJNAM</b> parameter.
|
|
</dd>
|
|
<dt><b><i>name</i></b></dt>
|
|
<dd>Specify the name of the folder that contains the document or folder named in the DLO parameter.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.DOCID"></a>
|
|
<h3>Document identifier (DOCID)</h3>
|
|
<p>Specifies the library-assigned name of the document. This is the name assigned to the document by the system when it was created. Documents filed outside the local system have only library-assigned document names. The library-assigned document names can be determined by using the Query Document Library (QRYDOCLIB) command or by the message returned from the File Document (FILDOC) command.
|
|
</p>
|
|
<p>Library-assigned document names are 24 characters in length with the following format:
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
YYYYMMDDHHMNSSHSSNSNSNSN
|
|
</pre>
|
|
</p>
|
|
<p>where:
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
YYYY = year
|
|
MM = month
|
|
DD = day
|
|
HH = hour
|
|
MN = minute
|
|
SS = second
|
|
HS = hundredths of a second
|
|
SNSNSNSN = system name
|
|
</pre>
|
|
</p>
|
|
<dl>
|
|
<dt><b>*NONE</b></dt>
|
|
<dd>A library-assigned document name is not specified for the object.
|
|
</dd>
|
|
<dt><b><i>name</i></b></dt>
|
|
<dd>Specify the library-assigned name of the document or folder object. The library-assigned document name can be determined by using the Query Document Library (QRYDOCLIB) command or by the message returned from the File Document (FILDOC) or other command.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.LADNTSP"></a>
|
|
<h3>LADN timestamp (LADNTSP)</h3>
|
|
<p>Specifies the library assigned document name (LADN) timestamp of the document or folder object. A LADN timestamp is specified only if *LADNTSP is specified on the <b>Document library object (DLO)</b> parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*NONE</u></b></dt>
|
|
<dd>A LADN timestamp is not specified for the object.
|
|
</dd>
|
|
<dt><b><i>timestamp</i></b></dt>
|
|
<dd>Specify the LADN timestamp of the document library object.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.SYSOBJNAM"></a>
|
|
<h3>System object name (SYSOBJNAM)</h3>
|
|
<p>Specifies the system object name of the document or folder object. A system object name is specified only if *SYSOBJNAM is specified on the <b>Document library object (DLO)</b> parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*NONE</u></b></dt>
|
|
<dd>A system object name is not specified for the object.
|
|
</dd>
|
|
<dt><b><i>name</i></b></dt>
|
|
<dd>Specify the system object name of the document library object.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.OBJCLS"></a>
|
|
<h3>Object class (OBJCLS)</h3>
|
|
<p>Specifies the class of the object to locate.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*DOC</u></b></dt>
|
|
<dd>The specified DLO is a filed document.
|
|
</dd>
|
|
<dt><b>*FLR</b></dt>
|
|
<dd>The specified DLO is a folder.
|
|
</dd>
|
|
<dt><b>*DST</b></dt>
|
|
<dd>The specified DLO is a distribution document.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.RTNDLO"></a>
|
|
<h3>CL var for RTNDLO (12) (RTNDLO)</h3>
|
|
<p>Specifies the name of a 12-character CL variable used to retrieve the user-assigned name of the selected document or folder. The *NONE value is returned for a distribution document or a document without a folder.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.RTNFLR"></a>
|
|
<h3>CL var for RTNFLR (63) (RTNFLR)</h3>
|
|
<p>Specifies the name of a 63-character CL variable used to retrieve the folder path of the selected document or folder. The *NONE value is returned for a distribution document, a document without a folder, or a first-level folder.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.RTNDOCID"></a>
|
|
<h3>CL var for RTNDOCID (24) (RTNDOCID)</h3>
|
|
<p>Specifies the name of a 24-character CL variable used to retrieve the library-assigned document name of the selected object. Refer to the <b>Document identifier (DOCID)</b> parameter for the format of the library-assigned document name.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.RTNLADNTSP"></a>
|
|
<h3>CL var for RTNLADNTSP (16) (RTNLADNTSP)</h3>
|
|
<p>Specifies the name of a 16-character CL variable used to retrieve the timestamp from the LADN of the selected object. The variable is in the form YYYYMMDDHHMNSSNN.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.RTNOBJNAM"></a>
|
|
<h3>CL var for RTNOBJNAM (10) (RTNOBJNAM)</h3>
|
|
<p>Specifies the name of a 10-character CL variable used to retrieve the system object name of the selected object.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.RTNOBJCLS"></a>
|
|
<h3>CL var for RTNOBJCLS (8) (RTNOBJCLS)</h3>
|
|
<p>Specifies the name of a 8-character CL variable used to retrieve the object class. A value of *DOC is returned for a filed document, *FLR for a folder, and *DST for a distribution document.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.RTNASP"></a>
|
|
<h3>CL var for RTNASP (2 0) (RTNASP)</h3>
|
|
<p>Specifies the name of a variable used to return the auxiliary storage pool ID. In control language (CL) programs, this should be a decimal variable of length (2 0). The following values can be returned:
|
|
</p>
|
|
<dl>
|
|
<dt><b>1</b></dt>
|
|
<dd>The object is in the system auxiliary storage pool.
|
|
</dd>
|
|
<dt><b>2-32</b></dt>
|
|
<dd>The object is in a user auxiliary storage pool.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="RTVDLONAM.RTNOVRFLW"></a>
|
|
<h3>CL var for RTNOVRFLW (1) (RTNOVRFLW)</h3>
|
|
<p>Specifies the name of a 1-character CL variable used to retrieve the overflow status of the object, where:
|
|
</p>
|
|
<ul>
|
|
<li>N = No, the object has not overflowed its ASP
|
|
</li>
|
|
<li>Y = Yes, the object has overflowed its ASP and part or all of the object resides in the system ASP
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="RTVDLONAM.COMMAND.EXAMPLES">Examples</a> </h3>
|
|
<p>
|
|
<pre>
|
|
RTVDLONAM DLO(MYDOC) FLR(MYFLR) OBJCLS(*DOC) +
|
|
RTNDOCID(&DOCID)
|
|
</pre>
|
|
</p>
|
|
<p>This command finds the document MYDOC in folder MYFLR and returns its document identifier in the variable &DOCID.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="RTVDLONAM.ERROR.MESSAGES">Error messages</a> </h3>
|
|
<p><b><u>*ESCAPE Messages</u></b>
|
|
</p>
|
|
<dl>
|
|
<dt><b>CPF8AC0</b></dt>
|
|
<dd>&1 command failed.
|
|
</dd>
|
|
<dt><b>CPF8AC1</b></dt>
|
|
<dd>Not authorized to distribution documents.
|
|
</dd>
|
|
<dt><b>CPF8A75</b></dt>
|
|
<dd>Not authorized to access folder &1.
|
|
</dd>
|
|
<dt><b>CPF8A77</b></dt>
|
|
<dd>Folder &1 not found.
|
|
</dd>
|
|
<dt><b>CPF8A82</b></dt>
|
|
<dd>Document &2 not found in folder &1.
|
|
</dd>
|
|
<dt><b>CPF8A83</b></dt>
|
|
<dd>Not authorized to access document &2 in folder &1.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#RTVDLONAM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</body>
|
|
</html>
|