264 lines
9.4 KiB
HTML
264 lines
9.4 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 Library Description (RTVLIBD)</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="RTVLIBD.Top_Of_Page"></a>
|
||
|
|
<h2>Retrieve Library Description (RTVLIBD)</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>Yes
|
||
|
|
</td>
|
||
|
|
<td valign="top" align="right">
|
||
|
|
<a href="#RTVLIBD.PARAMETERS.TABLE">Parameters</a><br>
|
||
|
|
<a href="#RTVLIBD.COMMAND.EXAMPLES">Examples</a><br>
|
||
|
|
<a href="#RTVLIBD.ERROR.MESSAGES">Error messages</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<div> <a name="RTVLIBD"></a>
|
||
|
|
<p>The Retrieve Library Description (RTVLIBD) command retrieves the description of a library. The values are returned (copied) to the specified variables in the program.
|
||
|
|
</p>
|
||
|
|
<p>For parameters that are returned into CL variables by this command, the parameter descriptive title/and prompt text lists the minimum length for the CL variable. For character variables, a single number is shown. For decimal variables, two numbers are shown. The first number indicates the minimum variable length and the second number indicates the minimum number of decimal positions.
|
||
|
|
</p>
|
||
|
|
<p><b>Restrictions:</b>
|
||
|
|
</p>
|
||
|
|
<ol>
|
||
|
|
<li>You must have some authority other than *EXCLUDE authority for the library to retrieve the attributes of the library.
|
||
|
|
</li>
|
||
|
|
<li>You must have either all object (*ALLOBJ) or audit (*AUDIT) special authority to retrieve a value other than *NOTAVL for the create object auditing value.
|
||
|
|
</li>
|
||
|
|
</ol>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
|
||
|
|
<div>
|
||
|
|
<h3><a name="RTVLIBD.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="#RTVLIBD.LIB"><b>LIB</b></a></td>
|
||
|
|
<td valign="top">Library</td>
|
||
|
|
<td valign="top"><i>Name</i></td>
|
||
|
|
<td valign="top">Required, Positional 1</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVLIBD.TYPE"><b>TYPE</b></a></td>
|
||
|
|
<td valign="top">CL var for TYPE (10)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVLIBD.ASP"><b>ASP</b></a></td>
|
||
|
|
<td valign="top">CL var for ASP (2 0)</td>
|
||
|
|
<td valign="top"><i>Decimal number</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVLIBD.ASPDEV"><b>ASPDEV</b></a></td>
|
||
|
|
<td valign="top">CL var for ASPDEV (10)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVLIBD.ASPGRP"><b>ASPGRP</b></a></td>
|
||
|
|
<td valign="top">CL var for ASPGRP (10)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVLIBD.CRTAUT"><b>CRTAUT</b></a></td>
|
||
|
|
<td valign="top">CL var for CRTAUT (10)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVLIBD.CRTOBJAUD"><b>CRTOBJAUD</b></a></td>
|
||
|
|
<td valign="top">CL var for CRTOBJAUD (10)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVLIBD.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>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div> <a name="RTVLIBD.LIB"></a>
|
||
|
|
<h3>Library (LIB)</h3>
|
||
|
|
<p>Specifies the library for which attributes are to be retrieved. If a variable is specified, it must be 10 characters in length and contain a library name.
|
||
|
|
</p>
|
||
|
|
<p>This is a required parameter.
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b><i>name</i></b></dt>
|
||
|
|
<dd>Specify the name of the library for which attributes are to be retrieved.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVLIBD.TYPE"></a>
|
||
|
|
<h3>CL var for TYPE (10) (TYPE)</h3>
|
||
|
|
<p>Specifies a 10-character variable used to return the library type. The value PROD or the value TEST is returned.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVLIBD.ASP"></a>
|
||
|
|
<h3>CL var for ASP (2 0) (ASP)</h3>
|
||
|
|
<p>Specifies a decimal (2 0) variable used to return the number of the auxiliary storage pool (ASP) from which the system allocates storage for the library. The following values can be returned:
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b>1</b></dt>
|
||
|
|
<dd>The library is in the system auxiliary storage pool.
|
||
|
|
</dd>
|
||
|
|
<dt><b>2-32</b></dt>
|
||
|
|
<dd>The library is in a user auxiliary storage pool.
|
||
|
|
</dd>
|
||
|
|
<dt><b>-1</b></dt>
|
||
|
|
<dd>The library is in a primary or secondary auxiliary storage pool (ASP) with an ASP number larger than 32. The ASP device name for the primary or secondary ASP can be retrieved with the ASPDEV parameter.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVLIBD.ASPDEV"></a>
|
||
|
|
<h3>CL var for ASPDEV (10) (ASPDEV)</h3>
|
||
|
|
<p>Specifies a 10-character variable used to return the name of the auxiliary storage pool (ASP) device where storage is allocated for the library. One of the following special values can be returned:
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b>*N</b></dt>
|
||
|
|
<dd>The name of the ASP device cannot be determined.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*SYSBAS</b></dt>
|
||
|
|
<dd>The library is in the system ASP (ASP 1) or in a basic user ASP (ASPs 2-32).
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVLIBD.ASPGRP"></a>
|
||
|
|
<h3>CL var for ASPGRP (10) (ASPGRP)</h3>
|
||
|
|
<p>Specifies a 10-character variable used to return the name of the auxiliary storage pool (ASP) group where storage is allocated for the library. The ASP group name is the name of the primary ASP within the ASP group. One of the following special values can be returned:
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b>*N</b></dt>
|
||
|
|
<dd>The name of the ASP device cannot be determined.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*SYSBAS</b></dt>
|
||
|
|
<dd>The library is in the system ASP (ASP 1) or in a basic user ASP (ASPs 2-32).
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVLIBD.CRTAUT"></a>
|
||
|
|
<h3>CL var for CRTAUT (10) (CRTAUT)</h3>
|
||
|
|
<p>Specifies a 10-character variable used to return the create authority value of the library. The value *SYSVAL, *CHANGE, *ALL, *USE, or *EXCLUDE, or the name of an authorization list is returned.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVLIBD.CRTOBJAUD"></a>
|
||
|
|
<h3>CL var for CRTOBJAUD (10) (CRTOBJAUD)</h3>
|
||
|
|
<p>Specifies a 10-character variable used to return the auditing value of the library. A value of *NOTAVL will be returned if you do not have either all object (*ALLOBJ) or audit (*AUDIT) special authority. The values that can be returned include *SYSVAL, *NONE, *USRPRF, *CHANGE, *ALL, and *NOTAVL. See the <b>Create object auditing (CRTOBJAUD)</b> parameter on the Create Library (CRTLIB) command for more information.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVLIBD.TEXT"></a>
|
||
|
|
<h3>CL var for TEXT (50) (TEXT)</h3>
|
||
|
|
<p>Specifies a 50-character CL variable used to return the text description of the library.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
<div><h3><a name="RTVLIBD.COMMAND.EXAMPLES">Examples</a> </h3>
|
||
|
|
<p>Assume that the library named TESTLIB was created as follows:
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<pre>
|
||
|
|
CRTLIB LIB(TESTLIB) CRTAUT(*ALL) TEXT('John Smith library')
|
||
|
|
</pre>
|
||
|
|
</p>
|
||
|
|
<p><b>PGM Example</b>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<pre>
|
||
|
|
DCL VAR(&CRTAUT) TYPE(*CHAR) LEN(10)
|
||
|
|
RTVLIBD LIB(TESTLIB) CRTAUT(&CRTAUT)
|
||
|
|
</pre>
|
||
|
|
</p>
|
||
|
|
<p>The RTVLIBD command will return a value of '*ALL ' in program variable &CRTAUT.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
<div><h3><a name="RTVLIBD.ERROR.MESSAGES">Error messages</a> </h3>
|
||
|
|
<p><b><u>*ESCAPE Messages</u></b>
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b>CPF210E</b></dt>
|
||
|
|
<dd>Library &1 not available.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF2115</b></dt>
|
||
|
|
<dd>Object &1 in &2 type *&3 damaged.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF2150</b></dt>
|
||
|
|
<dd>Object information function failed.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF2151</b></dt>
|
||
|
|
<dd>Operation failed for &2 in &1 type *&3.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF980B</b></dt>
|
||
|
|
<dd>Object &1 in library &2 not available.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF9810</b></dt>
|
||
|
|
<dd>Library &1 not found.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF9820</b></dt>
|
||
|
|
<dd>Not authorized to use library &1.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF9830</b></dt>
|
||
|
|
<dd>Cannot assign library &1.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVLIBD.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|