friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0332907f0f
ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/rtvmbrd.htm

711 lines
28 KiB
HTML
Raw Normal View History

Add readme and dist folders
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>Retrieve Member Description (RTVMBRD)</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="RTVMBRD.Top_Of_Page"></a>
<h2>Retrieve Member Description (RTVMBRD)</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="#RTVMBRD.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RTVMBRD.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RTVMBRD.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RTVMBRD"></a>
<p>The Retrieve Member Description (RTVMBRD) command is used in a CL program or REXX procedure to retrieve (return) the member-level information (in CL variables) from a database file.
</p>
<p>The values are returned (copied) to the specified CL variables. The following kinds of member information can be retrieved:
</p>
<ul>
<li>The library name.
</li>
<li>The member name.
</li>
<li>The file attribute.
</li>
<li>The file type.
</li>
<li>The source type.
</li>
<li>The source date.
</li>
<li>The date created.
</li>
<li>The expiration date.
</li>
<li>The member text.
</li>
<li>The number of nondeleted records.
</li>
<li>The number of deleted records.
</li>
<li>The open data path status (shared or not shared).
</li>
<li>The data space size.
</li>
<li>The access path size.
</li>
<li>The date changed.
</li>
<li>The date saved.
</li>
<li>The date restored.
</li>
<li>The number of data members.
</li>
<li>The last date used.
</li>
<li>The days count used.
</li>
<li>The date and days count was reset.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RTVMBRD.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" rowspan="3"><a href="#RTVMBRD.FILE"><b>FILE</b></a></td>
<td valign="top">File</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: File</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="#RTVMBRD.MBR"><b>MBR</b></a></td>
<td valign="top">Member</td>
<td valign="top">Single values: <b><u>*FIRST</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: Reference member</td>
<td valign="top">
<i>Generic name, name</i>, *FIRSTMBR, *LASTMBR</td>
</tr>
<tr>
<td valign="top">Element 2: Relationship</td>
<td valign="top">
<b><u>*SAME</u></b>, *NEXT, *PRV</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.RTNSYSTEM"><b>RTNSYSTEM</b></a></td>
<td valign="top">CL var for RTNSYSTEM (4)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.RTNLIB"><b>RTNLIB</b></a></td>
<td valign="top">CL var for RTNLIB (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.RTNMBR"><b>RTNMBR</b></a></td>
<td valign="top">CL var for RTNMBR (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.FILEATR"><b>FILEATR</b></a></td>
<td valign="top">CL var for FILEATR (3)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.FILETYPE"><b>FILETYPE</b></a></td>
<td valign="top">CL var for FILETYPE (5)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.SRCTYPE"><b>SRCTYPE</b></a></td>
<td valign="top">CL var for SRCTYPE (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.SRCCHGDATE"><b>SRCCHGDATE</b></a></td>
<td valign="top">CL var for SRCCHGDATE (13)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.CRTDATE"><b>CRTDATE</b></a></td>
<td valign="top">CL var for CRTDATE (13)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.EXPDATE"><b>EXPDATE</b></a></td>
<td valign="top">CL var for EXPDATE (7)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.TEXT"><b>TEXT</b></a></td>
<td valign="top">CL var for TEXT (50)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.NBRCURRCD"><b>NBRCURRCD</b></a></td>
<td valign="top">CL var for NBRCURRCD (10 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.NBRDLTRCD"><b>NBRDLTRCD</b></a></td>
<td valign="top">CL var for NBRDLTRCD (10 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.SHARE"><b>SHARE</b></a></td>
<td valign="top">CL var for SHARE (4)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.DTASPCSIZ"><b>DTASPCSIZ</b></a></td>
<td valign="top">CL var for DTASPCSIZ (15 0)</td>
<td valign="top"><i>Not restricted</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.ACCPTHSIZ"><b>ACCPTHSIZ</b></a></td>
<td valign="top">CL var for ACCPTHSIZ (12 0)</td>
<td valign="top"><i>Not restricted</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.CHGDATE"><b>CHGDATE</b></a></td>
<td valign="top">CL var for CHGDATE (13)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.SAVDATE"><b>SAVDATE</b></a></td>
<td valign="top">CL var for SAVDATE (13)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.RSTDATE"><b>RSTDATE</b></a></td>
<td valign="top">CL var for RSTDATE (13)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.NBRDTAMBRS"><b>NBRDTAMBRS</b></a></td>
<td valign="top">CL var for NBRDTAMBRS (2 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.USEDATE"><b>USEDATE</b></a></td>
<td valign="top">CL var for USEDATE (7)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.USECOUNT"><b>USECOUNT</b></a></td>
<td valign="top">CL var for USECOUNT (5 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVMBRD.RESETDATE"><b>RESETDATE</b></a></td>
<td valign="top">CL var for RESETDATE (7)</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="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RTVMBRD.FILE"></a>
<h3>File (FILE)</h3>
<p>Specifies the name and library of the file that contains the member description that is retrieved.
</p>
<p>This is a required parameter.
</p>
<p>
<b>Note: </b>You must have *USE authority to the file and *READ authority to the library before the member description information can be retrieved.
</p>
<p>The possible library values are:
</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 current entry exists in the library list, QGPL is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the library name to search.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.MBR"></a>
<h3>Member (MBR)</h3>
<p>Specifies the file member whose description is retrieved. Either a single value (*FIRST or *LAST) or a double value (reference member and relationship) can be specified.
</p>
<p>The possible single values are:
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member in a date-ordered list is retrieved.
</dd>
<dt><b>*LAST</b></dt>
<dd>The last member in a date-ordered list is retrieved.
</dd>
</dl>
<p>The possible reference members in double values are:
</p>
<dl>
<dt><b>*FIRSTMBR</b></dt>
<dd>The first member in a name ordered list is retrieved. The relationship value *SAME is required.
</dd>
<dt><b>*LASTMBR</b></dt>
<dd>The last member in a name ordered list is retrieved. The relationship value *SAME is required.
</dd>
<dt><b><i>member-name</i></b></dt>
<dd>Specify the name of the reference member. The relationship of the retrieved member to the reference member is specified on the second element of this parameter (*SAME, *NEXT, or *PRV). If a variable is specified, it must be a 10-character field that contains the name of the reference member.
</dd>
<dt><b><i>generic*-member-name</i></b></dt>
<dd>Specify the starting characters of the member name followed by an asterisk. This retrieves the first member in the name ordered list that starts with the specified characters. The relationship value is required to be *SAME.
</dd>
</dl>
<p>The possible relationships in double values are:
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The reference member is retrieved.
</dd>
<dt><b>*NEXT</b></dt>
<dd>The member immediately after the reference member in a name ordered list is retrieved.
</dd>
<dt><b>*PRV</b></dt>
<dd>The member immediately previous to the reference member in a name ordered list is retrieved.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.RTNSYSTEM"></a>
<h3>CL var for RTNSYSTEM (4) (RTNSYSTEM)</h3>
<p>Specifies the name of a variable used to retrieve the name of the system from which the file was retrieved. In CL programs, this should be a 4-character variable.
</p>
<p>The values that can be returned are *LCL (file found on the local system) and *RMT (file found on a remote system).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.RTNLIB"></a>
<h3>CL var for RTNLIB (10) (RTNLIB)</h3>
<p>Specifies the name of a variable used to retrieve the name of the library in which the file containing the specified file member is located. In CL programs, this should be a 10-character variable.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.RTNMBR"></a>
<h3>CL var for RTNMBR (10) (RTNMBR)</h3>
<p>Specifies the name of a variable used to retrieve the name of the file member whose description is being retrieved. In CL programs, this should be a 10-character variable.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.FILEATR"></a>
<h3>CL var for FILEATR (3) (FILEATR)</h3>
<p>Specifies the name of a variable used to retrieve the file attribute. In CL programs, this should be a 3-character variable.
</p>
<p>The values that can be returned are *PF (physical file member) and *LF (logical file member).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.FILETYPE"></a>
<h3>CL var for FILETYPE (5) (FILETYPE)</h3>
<p>Specifies the name of a variable used to retrieve the file type. In CL programs, this should be a 5-character variable.
</p>
<p>The values that are returned are *DATA (data file member) and *SRC (source file member).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.SRCTYPE"></a>
<h3>CL var for SRCTYPE (10) (SRCTYPE)</h3>
<p>Specifies the name of a variable used to retrieve the source file member type if this is a source file member. Blanks are returned if this is not a source file member. In CL programs, this should be a 10-character variable.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.SRCCHGDATE"></a>
<h3>CL var for SRCCHGDATE (13) (SRCCHGDATE)</h3>
<p>Specifies the name of a 13-character CL variable used to retrieve the century, date, and time the last source file member was changed. The format is CYYMMDDHHMMSS where C = Century (0 = 1940 through 1999 and 1 = 2000 through 2039), Y = Year, M = Month, D = Day, H = Hour, M = Minutes, and S = Seconds.
</p>
<p>Blanks are returned if no date is available. Remote non-AS/400 and non-System/38 files or non-source physical file return blanks.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.CRTDATE"></a>
<h3>CL var for CRTDATE (13) (CRTDATE)</h3>
<p>Specifies the name of a variable used to retrieve the file member creation century, date, and time. In CL programs, this should be a 13-character variable. The format is CYYMMDDHHMMSS where C = Century (0 = 1940 through 1999 and 1 = 2000 through 2039), Y = Year, M = Month, D = Day, H = Hour, M = Minutes, and S = Seconds.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.EXPDATE"></a>
<h3>CL var for EXPDATE (7) (EXPDATE)</h3>
<p>Specifies the name of a variable used to retrieve the file member expiration century and date. In CL programs, this should be a 7-character variable. The format is CYYMMDD where C = Century (0 = 1940 through 1999 and 1 = 2000 through 2039), Y = Year, M = Month, and D = Day.
</p>
<p>*NONE is returned if no date is available.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.TEXT"></a>
<h3>CL var for TEXT (50) (TEXT)</h3>
<p>Specifies the name of a variable used to retrieve the file member text. In CL programs, this should be a 50-character variable.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.NBRCURRCD"></a>
<h3>CL var for NBRCURRCD (10 0) (NBRCURRCD)</h3>
<p>Specifies the name of a variable used to retrieve the current number of nondeleted records in this file member. In CL programs, this should be a 10-position decimal variable.
</p>
<p>If the member is a keyed logical member, the number of index entries is returned. For nonkeyed logical members, the number of nondeleted records in the based-on physical file member is returned.
</p>
<p>For a join logical file, the number of records returned is a total of all the nondeleted records in the files being joined. This number includes those records that exist in the secondary file which do not have matching records in the primary file. If omit or select criteria is used, the number of records returned will be reduced or increased by the number of records meeting the selection criteria in the specified files.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.NBRDLTRCD"></a>
<h3>CL var for NBRDLTRCD (10 0) (NBRDLTRCD)</h3>
<p>Specifies the name of a variable used to retrieve the current number of deleted records in this file member. In CL programs, this should be a 10-position decimal variable. Zero (0) is returned for keyed logical files. Remote non-AS/400 and non-S/38 files return a value of 0. For nonkeyed logical files, the number of deleted records in the based-on physical file member is returned.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.SHARE"></a>
<h3>CL var for SHARE (4) (SHARE)</h3>
<p>Specifies the name of a variable used to retrieve a value indicating whether the open data path (ODP) allows sharing with other programs in the same job. In CL programs, this should be a 4-character variable.
</p>
<p>Values for ODP sharing are *YES (ODP sharing is allowed) and *NO (ODP sharing is not allowed).
</p>
<p>Remote non-AS/400 and non-S/38 files return *NO.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.DTASPCSIZ"></a>
<h3>CL var for DTASPCSIZ (15 0) (DTASPCSIZ)</h3>
<p>Specifies the name of a variable used to retrieve the data space size (in bytes) of this file member. In CL programs, this should be a 15-position decimal variable. Zero (0) is returned if this is a logical file member.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.ACCPTHSIZ"></a>
<h3>CL var for ACCPTHSIZ (12 0) (ACCPTHSIZ)</h3>
<p>Specifies the name of a variable used to retrieve the access path size (in bytes) for this file member. In CL programs, this should be a 12-position decimal variable. Zero (0) is returned if the file member is non-keyed. Remote non-AS/400 and non-S/38 files return a value of 0.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.CHGDATE"></a>
<h3>CL var for CHGDATE (13) (CHGDATE)</h3>
<p>Specifies the name of a variable used to retrieve the file change century, date, and time. In CL programs, this should be a 13-character variable. The format is CYYMMDDHHMMSS where C = Century (0 = 1940 through 1999 and 1 = 2000 through 2039), Y = Year, M = Month, D = Day, H = Hour, M = Minutes, and S = Seconds.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.SAVDATE"></a>
<h3>CL var for SAVDATE (13) (SAVDATE)</h3>
<p>Specifies the name of a variable used to retrieve the file member and the save century, date, and time. In CL programs, this should be a 13-character variable. The format is CYYMMDDHHMMSS where C = Century (0 = 1940 through 1999 and 1 = 2000 through 2039), Y = Year, M = Month, D = Day, H = Hour, M = Minutes, and S = Seconds.
</p>
<p>Blanks are returned if no date is available. Remote non-AS/400 and non-System/38 files return blanks.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.RSTDATE"></a>
<h3>CL var for RSTDATE (13) (RSTDATE)</h3>
<p>Specifies the name of a variable used to retrieve the file member and restore century, date, and time. In CL programs, this should be a 13-character variable. The format is CYYMMDDHHMMSS where C = Century (0 = 1940 through 1999 and 1 = 2000 through 2039), Y = Year, M = Month, D = Day, H = Hour, M = Minutes, and S = Seconds.
</p>
<p>Blanks are returned if there is no date available. Remote non-AS/400 and non-System/38 files return blanks.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.NBRDTAMBRS"></a>
<h3>CL var for NBRDTAMBRS (2 0) (NBRDTAMBRS)</h3>
<p>Specifies the name of a variable used to retrieve the number of data file members for this logical file member. In CL programs, this should be a 2-position decimal variable. If the member is a physical file member, a value of 0 is returned.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.USEDATE"></a>
<h3>CL var for USEDATE (7) (USEDATE)</h3>
<p>Specifies the name of a variable used to return the member last used century and date. In CL programs, this should be a 7-character variable. The format is CYYMMDD where C = Century (0 = 1940 through 1999 and 1 = 2000 through 2039), Y = Year, M = Month, and D = Day.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.USECOUNT"></a>
<h3>CL var for USECOUNT (5 0) (USECOUNT)</h3>
<p>Specifies the name of a variable that is used to return the number of days the member has been used. In CL programs, this should be a 5 decimal variable. If the member does not have a last used date, 0 is returned.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVMBRD.RESETDATE"></a>
<h3>CL var for RESETDATE (7) (RESETDATE)</h3>
<p>Specifies the name of a variable that is used to return the century and date the days used count was last reset to 0. In CL programs, this should be a 7-character variable. The format is CYYMMDD where C = Century (0 = 1940 through 1999 and 1 = 2000 through 2039), Y = Year, M = Month, and D = Day. If the days used count has not been reset, blanks are returned.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVMBRD.COMMAND.EXAMPLES">Examples</a> </h3>
<p>Assume the user has a file named MYFILE in library MYLIB (which is the current library) with members QMEMBER, BMEMBER, ZMEMBER, and JMEMBER (created in that order).
</p>
<p>Also assume the following variables are specified in the CL program:
</p>
<p>
<pre>
DCL &amp;LIB TYPE(*CHAR) LEN(10)
DCL &amp;MBR TYPE(*CHAR) LEN(10)
DCL &amp;SYS TYPE(*CHAR) LEN(4)
DCL &amp;MTYPE TYPE(*CHAR) LEN(5)
DCL &amp;CRTDATE TYPE(*CHAR) LEN(13)
DCL &amp;CHGDATE TYPE(*CHAR) LEN(13)
DCL &amp;TEXT TYPE(*CHAR) LEN(50)
DCL &amp;NBRRCD TYPE(*DEC) LEN(10 0)
DCL &amp;SIZE TYPE(*DEC) LEN(10 0)
</pre>
</p>
<p><b>Example 1: Retrieving Member Description Values</b>
</p>
<p>
<pre>
RTVMBRD FILE(*CURLIB/MYFILE) MBR(BMEMBER *SAME) +
RTNLIB(&amp;LIB) RTNSYSTEM(&amp;SYS) +
RTNMBR(&amp;MBR) FILEATR(&amp;MTYPE) +
CRTDATE(&amp;CRTDATE) TEXT(&amp;TEXT) +
NBRCURRCD(&amp;NBRRCD) DTASPCSIZ(&amp;SIZE)
</pre>
</p>
<p>This command retrieves the member description for member BMEMBER of file MYFILE located using the library list. The requested information is placed in the CL variables as follows:
</p>
<ul>
<li>The current library name (MYLIB) is placed in the CL variable named &amp;LIB.
</li>
<li>The system on which MYFILE was found is placed in the CL variable named &amp;SYS. (*LCL means the file was found on the local system, and *RMT means the file was found on a remote system.)
</li>
<li>The member name (BMEMBER) is placed in the CL variable named &amp;MBR.
</li>
<li>The file attribute of MYFILE is placed in the CL variable named &amp;MTYPE. (*DATA means the member is a data member, and *SRC means the file is a source member.)
</li>
<li>The creation date of BMEMBER is placed in the CL variable named &amp;CRTDATE.
</li>
<li>The text associated with BMEMBER is placed in the CL variable called &amp;TEXT.
</li>
<li>The current number of records in BMEMBER is placed in the CL variable called &amp;NBRRCD.
</li>
<li>The size of BMEMBER's data space (in bytes) is placed in the CL variable called &amp;SIZE.
</li>
</ul>
<p><b>Example 1: Retrieving the Next Member Description</b>
</p>
<p>
<pre>
RTVMBRD FILE(&amp;LIB/MYFILE) MBR(&amp;MBR *NEXT) +
RTNMBR(&amp;MBR) CRTDATE(&amp;CRTDATE) +
TEXT(&amp;TEXT) NBRCURRCD(&amp;NBRRCD) +
DTASPCSIZ(&amp;SIZE)
</pre>
</p>
<p>This command retrieves the member description for the member of file MYFILE which is "next" (in name order). The requested information is placed in the CL variables as follows:
</p>
<ul>
<li>The next member's name after BMEMBER (JMEMBER since the file is searched in name order) in MYFILE is placed in the CL variable named &amp;MBR.
</li>
<li>The creation date of JMEMBER is placed in the CL variable named &amp;CRTDATE.
</li>
<li>The text associated with JMEMBER is placed in the CL variable called &amp;TEXT.
</li>
<li>The current number of records in JMEMBER is placed in the CL variable called &amp;NBRRCD.
</li>
<li>The size of JMEMBER's data space (in bytes) is placed in the CL variable called &amp;SIZE.
</li>
</ul>
<p>The file can also be searched backwards. An example is:
</p>
<p>
<pre>
RTVMBRD FILE(*CURLIB/MYFILE) MBR(ZMEMBER *PRV) +
RTNMBR(&amp;MBR) CHGDATE(&amp;CHGDATE) TEXT(&amp;TEXT)
</pre>
</p>
<p>The requested information is placed in the CL variables as follows:
</p>
<ul>
<li>The member name (QMEMBER since it is the member just previous to ZMEMBER in a name-ordered list) is placed in the CL variable named &amp;MBR.
</li>
<li>The date QMEMBER was last changed is placed in the CL variable named &amp;CHGDATE.
</li>
<li>The text associated with QMEMBER is placed in the CL variable called &amp;TEXT.
</li>
</ul>
<p>If only the first part of the member name is known, you can use a generic name (or partial name) search of the list of members, as follows:
</p>
<p>
<pre>
RTVMBRD FILE(*LIBL/MYFILE) MBR(JM*) RTNMBR(&amp;MBR) +
CHGDATE(&amp;CHGDATE) TEXT(&amp;TEXT)
</pre>
</p>
<p>The requested information is placed in the CL variables as follows:
</p>
<ul>
<li>The member name (JMEMBER since it is the first member starting with the characters JM in a name ordered list) is placed in the CL variable named &amp;MBR.
</li>
<li>The date JMEMBER was last changed is placed in the CL variable named &amp;CHGDATE.
</li>
<li>The text associated with JMEMBER is placed in the CL variable called &amp;TEXT.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVMBRD.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF3018</b></dt>
<dd>Member &amp;3 for file &amp;1 in &amp;2 not available.
</dd>
<dt><b>CPF3019</b></dt>
<dd>File &amp;1 in library &amp;2 has no members.
</dd>
<dt><b>CPF3027</b></dt>
<dd>File &amp;1 in &amp;2 not a database file.
</dd>
<dt><b>CPF3038</b></dt>
<dd>Attributes for return variable &amp;1 not valid.
</dd>
<dt><b>CPF3039</b></dt>
<dd>Return variable &amp;1 too small to hold result.
</dd>
<dt><b>CPF3049</b></dt>
<dd>*NEXT or *PRV member does not exist.
</dd>
<dt><b>CPF3051</b></dt>
<dd>File &amp;1 in library &amp;2 not available.
</dd>
<dt><b>CPF325F</b></dt>
<dd>Conversion of the text failed.
</dd>
<dt><b>CPF327B</b></dt>
<dd>File &amp;1 information cannot be retrieved.
</dd>
<dt><b>CPF8109</b></dt>
<dd>&amp;8 damage on physical database file &amp;4.
</dd>
<dt><b>CPF8110</b></dt>
<dd>&amp;8 damage on logical data base file &amp;4 in &amp;9. VLOG-&amp;7.
</dd>
<dt><b>CPF8111</b></dt>
<dd>&amp;8 damage on member &amp;9 file &amp;4.
</dd>
<dt><b>CPF9803</b></dt>
<dd>Cannot allocate object &amp;2 in library &amp;3.
</dd>
<dt><b>CPF9806</b></dt>
<dd>Cannot perform function for object &amp;2 in library &amp;3.
</dd>
<dt><b>CPF9810</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF9812</b></dt>
<dd>File &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF9815</b></dt>
<dd>Member &amp;5 file &amp;2 in library &amp;3 not found.
</dd>
<dt><b>CPF9820</b></dt>
<dd>Not authorized to use library &amp;1.
</dd>
<dt><b>CPF9822</b></dt>
<dd>Not authorized to file &amp;1 in library &amp;2.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVMBRD.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink