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

1492 lines
62 KiB
HTML
Raw Blame History

<!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 Object Description (RTVOBJD)</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="RTVOBJD.Top_Of_Page"></a>
<h2>Retrieve Object Description (RTVOBJD)</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="#RTVOBJD.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RTVOBJD.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RTVOBJD.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RTVOBJD"></a>
<p>The Retrieve Object Description (RTVOBJD) command retrieves the description of a specific object to a CL program or REXX procedure.
</p>
<p>For parameters that are returned into CL variables by this command, the parameter descriptive title/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 execute (*EXECUTE) authority for the library.
</li>
<li>You must have some authority other than *EXCLUDE authority for the object. If the object is a file, you must have object operational (*OBJOPR) authority for the object.
</li>
<li>You must have either all object (*ALLOBJ) or audit (*AUDIT) special authority to retrieve a value other than *NOTAVL for the OBJAUD parameter.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RTVOBJD.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="#RTVOBJD.OBJ"><b>OBJ</b></a></td>
<td valign="top">Object</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: Object</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"><a href="#RTVOBJD.OBJTYPE"><b>OBJTYPE</b></a></td>
<td valign="top">Object type</td>
<td valign="top">*ALRTBL, *AUTL, *BNDDIR, *CFGL, *CHTFMT, *CLD, *CLS, *CMD, *CNNL, *COSD, *CRG, *CRQD, *CSI, *CSPMAP, *CSPTBL, *CTLD, *DEVD, *DOC, *DTAARA, *DTADCT, *DTAQ, *EDTD, *EXITRG, *FCT, *FILE, *FLR, *FNTRSC, *FNTTBL, *FORMDF, *FTR, *GSS, *IGCDCT, *IGCSRT, *IGCTBL, *IMGCLG, *IPXD, *JOBD, *JOBQ, *JOBSCD, *JRN, *JRNRCV, *LIB, *LIND, *LOCALE, *MEDDFN, *MENU, *MGTCOL, *MODD, *MODULE, *MSGF, *MSGQ, *M36, *M36CFG, *NODGRP, *NODL, *NTBD, *NWID, *NWSCFG, *NWSD, *OUTQ, *OVL, *PAGDFN, *PAGSEG, *PDFMAP, *PDG, *PGM, *PNLGRP, *PRDAVL, *PRDDFN, *PRDLOD, *PSFCFG, *QMFORM, *QMQRY, *QRYDFN, *RCT, *SBSD, *SCHIDX, *SPADCT, *SQLPKG, *SQLUDT, *SRVPGM, *SSND, *SVRSTG, *S36, *TBL, *TIMZON, *USRIDX, *USRPRF, *USRQ, *USRSPC, *VLDL, *WSCST</td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#RTVOBJD.ASPDEV"><b>ASPDEV</b></a></td>
<td valign="top">ASP device</td>
<td valign="top">Single values: <b><u>*</u></b>, *ALLAVL, *CURASPGRP, *SYSBAS<br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Device</td>
<td valign="top">
<i>Name</i></td>
</tr>
<tr>
<td valign="top">Element 2: Search type</td>
<td valign="top">
<b><u>*ASP</u></b>, *ASPGRP</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.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="#RTVOBJD.OBJATR"><b>OBJATR</b></a></td>
<td valign="top">CL var for OBJATR (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.USRDFNATR"><b>USRDFNATR</b></a></td>
<td valign="top">CL var for USRDFNATR (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.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="#RTVOBJD.OWNER"><b>OWNER</b></a></td>
<td valign="top">CL var for OWNER (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.PGP"><b>PGP</b></a></td>
<td valign="top">CL var for PGP (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.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="#RTVOBJD.LIBASP"><b>LIBASP</b></a></td>
<td valign="top">CL var for LIBASP (5 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.OBJASPDEV"><b>OBJASPDEV</b></a></td>
<td valign="top">CL var for OBJASPDEV (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.OBJASPGRP"><b>OBJASPGRP</b></a></td>
<td valign="top">CL var for OBJASPGRP (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.LIBASPDEV"><b>LIBASPDEV</b></a></td>
<td valign="top">CL var for LIBASPDEV (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.LIBASPGRP"><b>LIBASPGRP</b></a></td>
<td valign="top">CL var for LIBASPGRP (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.OVFASP"><b>OVFASP</b></a></td>
<td valign="top">CL var for OVFASP (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.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="#RTVOBJD.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="#RTVOBJD.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="#RTVOBJD.SAVACTDATE"><b>SAVACTDATE</b></a></td>
<td valign="top">CL var for SAVACTDATE (13)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.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="#RTVOBJD.CRTUSER"><b>CRTUSER</b></a></td>
<td valign="top">CL var for CRTUSER (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.CRTSYSTEM"><b>CRTSYSTEM</b></a></td>
<td valign="top">CL var for CRTSYSTEM (8)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.OBJDMN"><b>OBJDMN</b></a></td>
<td valign="top">CL var for OBJDMN (2)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.USEUPD"><b>USEUPD</b></a></td>
<td valign="top">CL var for USEUPD (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.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="#RTVOBJD.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="#RTVOBJD.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>
<tr>
<td valign="top"><a href="#RTVOBJD.STG"><b>STG</b></a></td>
<td valign="top">CL var for STG (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.CPR"><b>CPR</b></a></td>
<td valign="top">CL var for CPR (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SIZE"><b>SIZE</b></a></td>
<td valign="top">CL var for SIZE (15 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SPCSIZE"><b>SPCSIZE</b></a></td>
<td valign="top">CL var for SPCSIZE (15 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SPCALIGN"><b>SPCALIGN</b></a></td>
<td valign="top">CL var for SPCALIGN (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SAVSIZE"><b>SAVSIZE</b></a></td>
<td valign="top">CL var for SAVSIZE (15 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SAVCMD"><b>SAVCMD</b></a></td>
<td valign="top">CL var for SAVCMD (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SAVSEQNBR"><b>SAVSEQNBR</b></a></td>
<td valign="top">CL var for SAVSEQNBR (4 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SAVLRGSEQ"><b>SAVLRGSEQ</b></a></td>
<td valign="top">CL var for SAVLRGSEQ (10 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SAVVOL"><b>SAVVOL</b></a></td>
<td valign="top">CL var for SAVVOL (71)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SAVDEV"><b>SAVDEV</b></a></td>
<td valign="top">CL var for SAVDEV (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SAVF"><b>SAVF</b></a></td>
<td valign="top">CL var for SAVF (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SAVFLIB"><b>SAVFLIB</b></a></td>
<td valign="top">CL var for SAVFLIB (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SAVLABEL"><b>SAVLABEL</b></a></td>
<td valign="top">CL var for SAVLABEL (17)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SRCF"><b>SRCF</b></a></td>
<td valign="top">CL var for SRCF (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SRCFLIB"><b>SRCFLIB</b></a></td>
<td valign="top">CL var for SRCFLIB (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SRCMBR"><b>SRCMBR</b></a></td>
<td valign="top">CL var for SRCMBR (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SRCDATE"><b>SRCDATE</b></a></td>
<td valign="top">CL var for SRCDATE (13)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SYSLVL"><b>SYSLVL</b></a></td>
<td valign="top">CL var for SYSLVL (9)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.COMPILER"><b>COMPILER</b></a></td>
<td valign="top">CL var for COMPILER (16)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.OBJLVL"><b>OBJLVL</b></a></td>
<td valign="top">CL var for OBJLVL (8)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.ALWAPICHG"><b>ALWAPICHG</b></a></td>
<td valign="top">CL var for ALWAPICHG (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.APICHG"><b>APICHG</b></a></td>
<td valign="top">CL var for APICHG (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.USRCHG"><b>USRCHG</b></a></td>
<td valign="top">CL var for USRCHG (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.LICPGM"><b>LICPGM</b></a></td>
<td valign="top">CL var for LICPGM (16)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.PTF"><b>PTF</b></a></td>
<td valign="top">CL var for PTF (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.APAR"><b>APAR</b></a></td>
<td valign="top">CL var for APAR (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.OBJAUD"><b>OBJAUD</b></a></td>
<td valign="top">CL var for OBJAUD (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.OBJSIG"><b>OBJSIG</b></a></td>
<td valign="top">CL var for OBJSIG (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.SYSSIG"><b>SYSSIG</b></a></td>
<td valign="top">CL var for SYSSIG (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.MLTSIG"><b>MLTSIG</b></a></td>
<td valign="top">CL var for MLTSIG (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.JRNSTS"><b>JRNSTS</b></a></td>
<td valign="top">CL var for JRNSTS (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.JRN"><b>JRN</b></a></td>
<td valign="top">CL var for JRN (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.JRNLIB"><b>JRNLIB</b></a></td>
<td valign="top">CL var for JRNLIB (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.JRNIMG"><b>JRNIMG</b></a></td>
<td valign="top">CL var for JRNIMG (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.JRNOMTE"><b>JRNOMTE</b></a></td>
<td valign="top">CL var for JRNOMTE (1)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.JRNSTRDATE"><b>JRNSTRDATE</b></a></td>
<td valign="top">CL var for JRNSTRDATE (13)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.STRJRNRCV"><b>STRJRNRCV</b></a></td>
<td valign="top">CL var for STRJRNRCV (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.JRNRCVLIB"><b>JRNRCVLIB</b></a></td>
<td valign="top">CL var for JRNRCVLIB (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.RCVLIBASP"><b>RCVLIBASP</b></a></td>
<td valign="top">CL var for RCVLIBASP (10)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVOBJD.RCVLIBGRP"><b>RCVLIBGRP</b></a></td>
<td valign="top">CL var for RCVLIBGRP (10)</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="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RTVOBJD.OBJ"></a>
<h3>Object (OBJ)</h3>
<p>Specifies the object for which you want to retrieve information.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Object</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the object for which the description is to be retrieved.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</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. If the <b>ASP device (ASPDEV)</b> parameter is specified when this value is used, ASPDEV(*) is the only valid value.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched. If the <b>ASP device (ASPDEV)</b> parameter is specified when this value is used, ASPDEV(*) is the only valid value.
</dd>
</dl>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.OBJTYPE"></a>
<h3>Object type (OBJTYPE)</h3>
<p>Specifies the type of the object for which you want to retrieve the information.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b><i>object-type</i></b></dt>
<dd>Specify the type of the object for which information is to be retrieved.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.ASPDEV"></a>
<h3>ASP device (ASPDEV)</h3>
<p>Specifies the auxiliary storage pool (ASP) device name where storage is allocated for the library containing the object. If the library resides in an ASP that is not part of the thread's library name space, this parameter must be specified to ensure the correct library is searched. If this parameter is used when the library qualifier specified for the <b>Object (OBJ)</b> parameter is *CURLIB or *LIBL, ASPDEV(*) is the only valid value. This parameter can be specified as a single value or a list of one or two elements.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The ASPs that are currently part of the thread's library name space will be searched to find the library. 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>
</dl>
<dl>
<dt><b>*ALLAVL</b></dt>
<dd>All available ASPs will be searched. This includes the system ASP (ASP 1), all defined basic user ASPs (ASPs 2-32), and all available primary and secondary ASPs (ASPs 33-255 with a status of 'Available').
</dd>
</dl>
<dl>
<dt><b>*CURASPGRP</b></dt>
<dd>If the thread has an ASP group, the primary and secondary ASPs in the thread's ASP group will be searched to find the library. The system ASP (ASP 1) and defined basic user ASPs (ASPs 2-32) will not be searched. If no ASP group is associated with the thread an error will be issued.
</dd>
</dl>
<dl>
<dt><b>*SYSBAS</b></dt>
<dd>The system ASP (ASP 1) and all defined basic user ASPs (ASPs 2-32) will be searched to find the library. No primary or secondary ASPs will be searched, even if the thread has an ASP group.
</dd>
</dl>
<p><b>Element 1: Device</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>
</dd>
</dl>
<p>Specify the name of the primary or secondary ASP device to be searched. The primary or secondary ASP must have been activated (by varying on the ASP device) and have a status of 'Available'. The system ASP (ASP 1) and defined basic user ASPs (ASPs 2-32) will not be searched.
</p>
<p>
<b>Note: </b>To specify a specific auxiliary storage pool (ASP) device name when the search type specified for element 2 is *ASP, you must have execute (*EXECUTE) authority for the specific ASP device.
</p>
<p>To specify a specific auxiliary storage pool (ASP) device name when the search type specified for element 2 is *ASPGRP, you must have execute (*EXECUTE) authority for each ASP device in the ASP group.
</p>
<p><b>Element 2: Search type</b>
</p>
<p>Specifies whether the single ASP device or the entire ASP group named in element 1 is to be searched.
</p>
<dl>
<dt><b><u>*ASP</u></b></dt>
<dd>Only the single auxiliary storage pool (ASP) device named in element 1 is to be searched.
</dd>
<dt><b>*ASPGRP</b></dt>
<dd>The entire group of the primary auxiliary storage pool (ASP) device named in element 1 is to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.RTNLIB"></a>
<h3>CL var for RTNLIB (10) (RTNLIB)</h3>
<p>Specifies a 10-character variable used to return the name of the library that contains the object. If *LIBL or *CURLIB is specified for the library (qualifier 2) of the <b>Object (OBJ)</b> parameter, the value returned is the name of the library where the object was found. If a library name is specified, that name is returned by this parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.OBJATR"></a>
<h3>CL var for OBJATR (10) (OBJATR)</h3>
<p>Specifies a 10-character variable used to return an extended attribute of the object such as a program or file type. For example, the variable may be returned with PROD or CLP. No * will precede the value.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.USRDFNATR"></a>
<h3>CL var for USRDFNATR (10) (USRDFNATR)</h3>
<p>Specifies 10-character variable used to return the user-defined attribute of the object. Blanks are returned if the retrieved object does not have a user-defined attribute.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.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 object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.OWNER"></a>
<h3>CL var for OWNER (10) (OWNER)</h3>
<p>Specifies a 10-character variable used to return the name of the owner of the object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.PGP"></a>
<h3>CL var for PGP (10) (PGP)</h3>
<p>Specifies a 10-character variable used to return the name of the user who is the primary group for the object. If there is no primary group for the object, this field contains a value of *NONE.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.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) number for the object. This variable will contain an ASP number up to 32. If an ASP number is larger than 32, -1 is returned in this variable. The OBJASPDEV parameter should be used to return the ASP device name when the ASP number is larger than 32. 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 basic user auxiliary storage pool.
</dd>
<dt><b>-1</b></dt>
<dd>The object is in a primary or secondary auxiliary storage pool with an ASP number larger than 32. The ASP device name for the primary or secondary ASP can be retrieved with the OBJASPDEV parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.LIBASP"></a>
<h3>CL var for LIBASP (5 0) (LIBASP)</h3>
<p>Specifies a decimal (5 0) variable used to return the number of the auxiliary storage pool (ASP) where storage is allocated for the library that contains the object. This variable will contain an ASP number up to 32. If an ASP number is larger than 32, -1 is returned in this variable. The LIBASPDEV parameter should be used to return the ASP device name when the ASP number is larger than 32. 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 basic user auxiliary storage pool.
</dd>
<dt><b>-1</b></dt>
<dd>The library is in a primary or secondary auxiliary storage pool with an ASP number larger than 32. The ASP device name for the primary or secondary ASP can be retrieved with the LIBASPDEV parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.OBJASPDEV"></a>
<h3>CL var for OBJASPDEV (10) (OBJASPDEV)</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 object. 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 object 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="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.OBJASPGRP"></a>
<h3>CL var for OBJASPGRP (10) (OBJASPGRP)</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 object. The ASP group name is the name of the primary ASP within the ASP group. The value returned may be the same as the value returned for the OBJASPDEV parameter. The following special values can be returned:
</p>
<dl>
<dt><b>*N</b></dt>
<dd>The name of the primary ASP device cannot be determined.
</dd>
<dt><b>*SYSBAS</b></dt>
<dd>The object 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="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.LIBASPDEV"></a>
<h3>CL var for LIBASPDEV (10) (LIBASPDEV)</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 that contains the object. 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="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.LIBASPGRP"></a>
<h3>CL var for LIBASPGRP (10) (LIBASPGRP)</h3>
<p>Specifies a 10-character variable used to return the name of the primary auxiliary storage pool (ASP) group where storage is allocated for the library that contains the object. The ASP group name is the name of the primary ASP within the ASP group. The value returned may be the same as the value returned for the LIBASPDEV parameter. The following special values can be returned:
</p>
<dl>
<dt><b>*N</b></dt>
<dd>The name of the primary ASP device cannot be determined.
</dd>
<dt><b>*SYSBAS</b></dt>
<dd>The object 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="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.OVFASP"></a>
<h3>CL var for OVFASP (1) (OVFASP)</h3>
<p>Specifies a 1-character variable used to return the Object Overflowed auxiliary storage pool (ASP) flag.
</p>
<dl>
<dt><b>'1'</b></dt>
<dd>The object overflowed the ASP in which it resides.
</dd>
<dt><b>'0'</b></dt>
<dd>The object does not overflow the ASP. It is not possible for an object residing in the system ASP (ASP 1) or in a primary or secondary ASP (ASPs 33-255) to overflow its ASP, therefore, a value of '0' is always returned for objects in the system ASP (ASP 1) or in a primary or secondary ASP (ASPs 33-255).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.CRTDATE"></a>
<h3>CL var for CRTDATE (13) (CRTDATE)</h3>
<p>Specifies a 13-character variable used to return the date and time the object was created. A value is returned in the form CYYMMDDHHMMSS where C = century; '0' indicates years 19xx and '1' indicates years 20xx; YY = year, MM = month, DD = day, HH = hour, MM = minutes and SS = seconds.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.CHGDATE"></a>
<h3>CL var for CHGDATE (13) (CHGDATE)</h3>
<p>Specifies a 13-character variable used to return the date and time the object was last changed. The variable is returned in the same format as the CRTDATE parameter or is returned blank if the object has not been changed.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVDATE"></a>
<h3>CL var for SAVDATE (13) (SAVDATE)</h3>
<p>Specifies a 13-character variable used to return the date and time the object was last saved. The variable is returned in the same format as the CRTDATE parameter or is returned blank if the object has not been saved.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVACTDATE"></a>
<h3>CL var for SAVACTDATE (13) (SAVACTDATE)</h3>
<p>Specifies a 13-character variable used to return the date and time the object was last saved during a save operation with the SAVACT parameter specified as something other than *NO. This date/time indicates when the object itself was saved; the SAVDAT parameter indicates when the save operation was started. The variable is returned in the same format as the CRTDATE parameter or is returned blank if the object has not been saved or if SAVACT(*NO) was specified for the last save operation for the object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.RSTDATE"></a>
<h3>CL var for RSTDATE (13) (RSTDATE)</h3>
<p>Specifies a 13-character variable used to return the date and time the object was last restored. The variable is returned in the same format as the CRTDATE parameter or is returned blank if the object has not been restored.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.CRTUSER"></a>
<h3>CL var for CRTUSER (10) (CRTUSER)</h3>
<p>Specifies a 10-character variable used to return the name of the user that created the object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.CRTSYSTEM"></a>
<h3>CL var for CRTSYSTEM (8) (CRTSYSTEM)</h3>
<p>Specifies an 8-character variable used to return the name of the system on which the object was created.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.OBJDMN"></a>
<h3>CL var for OBJDMN (2) (OBJDMN)</h3>
<p>Specifies a 2-character variable used to return the object domain value for the object. The following values can be returned:
</p>
<dl>
<dt><b>*U</b></dt>
<dd>The object is a user domain object.
</dd>
<dt><b>*S</b></dt>
<dd>The object is a system domain object.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.USEUPD"></a>
<h3>CL var for USEUPD (1) (USEUPD)</h3>
<p>Specifies a 1-character variable used to return whether the object usage information is updated for this object type. The following values can be returned:
</p>
<dl>
<dt><b>Y</b></dt>
<dd>Object usage information is updated for this object type.
</dd>
<dt><b>N</b></dt>
<dd>Object usage information is not updated for this object type. If 'N' is returned, the last used date for the object is blank and the number of days the object has been used is zero (0).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.USEDATE"></a>
<h3>CL var for USEDATE (7) (USEDATE)</h3>
<p>Specifies a 7-character variable used to return the date the object was last used. The date is returned in the form CYYMMDD or is returned blank if the object does not have a last used date.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.USECOUNT"></a>
<h3>CL var for USECOUNT (5 0) (USECOUNT)</h3>
<p>Specifies a decimal (5 0) variable used to return the number of days the object has been used. If the object does not have a last used date, zero (0) is returned.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.RESETDATE"></a>
<h3>CL var for RESETDATE (7) (RESETDATE)</h3>
<p>Specifies a 7-character variable used to return the date the days used count was last reset to zero (0). The date is returned in the form CYYMMDD or is returned blank if the days used count has not been reset.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.STG"></a>
<h3>CL var for STG (10) (STG)</h3>
<p>Specifies a 10-character variable used to return the storage status of the object data. The following values can be returned:
</p>
<dl>
<dt><b>*FREE</b></dt>
<dd>The object data has been freed and the object is suspended.
</dd>
<dt><b>*KEEP</b></dt>
<dd>The object data has not been freed and the object has not been suspended.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.CPR"></a>
<h3>CL var for CPR (1) (CPR)</h3>
<p>Specifies a 1-character variable used to return the compression status of the object. The following values can be returned:
</p>
<dl>
<dt><b>Y</b></dt>
<dd>The object is compressed.
</dd>
<dt><b>X</b></dt>
<dd>The object is ineligible for compression.
</dd>
<dt><b>N</b></dt>
<dd>The object is permanently decompressed.
</dd>
<dt><b>T</b></dt>
<dd>The object is temporarily decompressed.
</dd>
<dt><b>F</b></dt>
<dd>The object is eligible for compression but is saved with storage freed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SIZE"></a>
<h3>CL var for SIZE (15 0) (SIZE)</h3>
<p>Specifies a decimal (15 0) variable used to return the size of the object in bytes. This value includes the value returned by the SPCSIZE parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SPCSIZE"></a>
<h3>CL var for SPCSIZE (15 0) (SPCSIZE)</h3>
<p>Specifies a decimal (15 0) variable used to return the size of the primary associated space of object in bytes. If the object has no associated space, zero (0) is returned.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SPCALIGN"></a>
<h3>CL var for SPCALIGN (1) (SPCALIGN)</h3>
<p>Specifies a 1-character variable used to return whether the space associated with the object has been optimally aligned. Optimum alignment may allow for better performance of applications that use the object. The following values can be returned:
</p>
<dl>
<dt><b>'0'</b></dt>
<dd>The space associated with the object has not been optimally aligned.
</dd>
<dt><b>'1'</b></dt>
<dd>The space associated with the object has been optimally aligned.
</dd>
<dt><b>'2'</b></dt>
<dd>There is not a space associated with the object.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVSIZE"></a>
<h3>CL var for SAVSIZE (15 0) (SAVSIZE)</h3>
<p>Specifies a decimal (15 0) variable used to return the size of the object in bytes at the time of the last save operation. If the object has not been saved, zero (0) is returned.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVCMD"></a>
<h3>CL var for SAVCMD (10) (SAVCMD)</h3>
<p>Specifies a 10-character variable used to return the command used to save the object. If the object has not been saved, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVSEQNBR"></a>
<h3>CL var for SAVSEQNBR (4 0) (SAVSEQNBR)</h3>
<p>Specifies a decimal (4 0) variable used to return the tape sequence number assigned when the object was saved on tape. This variable will contain a sequence number up to 9999. If the object has not been saved or was not saved to tape, zero (0) is returned. If a sequence number is actually greater than 9999, -5 is returned in this variable. The SAVLRGSEQ parameter should be used to return a sequence number which can be larger than 9999.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVLRGSEQ"></a>
<h3>CL var for SAVLRGSEQ (10 0) (SAVLRGSEQ)</h3>
<p>Specifies a decimal (10 0) variable used to return the tape sequence number (similar to the SAVSEQNBR parameter). This variable can contain a larger tape sequence number than the SAVSEQNBR parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVVOL"></a>
<h3>CL var for SAVVOL (71) (SAVVOL)</h3>
<p>Specifies a 71-character variable used to return the tape, diskette, or optical volumes used for saving the object. The variable returns a maximum of 10 six-character volumes. The volume IDs begin in character positions 1, 8, 15, 22, 29, 36, 43, 50, 57, and 64. Each volume ID entry is separated by a single character. If the object was saved in parallel format, the separator character contains a '2' before the first volume in the second media file, a '3' before the third media file, and so on, up to a '0' before the tenth media file. Otherwise, the separator characters are blank. If more than 10 volumes are used and the object was saved in serial format, '1' is returned in the 71st character of the variable. If the object was saved in parallel format, a '2' is returned in the 71st character of the variable. Otherwise, the 71st character is blank. If the object was last saved to a save file or was never saved, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVDEV"></a>
<h3>CL var for SAVDEV (10) (SAVDEV)</h3>
<p>Specifies a 10-character variable used to return the type of the device to which the object was last saved. The variable is returned with one of the following values, dependent on the device used for the last save operation:
</p>
<ul>
<li>*SAVF for a save file
</li>
<li>*DKT for a diskette
</li>
<li>*TAP for a tape
</li>
<li>*OPT for an optical volume
</li>
<li>The variable is returned blank if the object was not saved.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVF"></a>
<h3>CL var for SAVF (10) (SAVF)</h3>
<p>Specifies a 10-character variable used to return the name of the save file if the object was saved to a save file. If the object was not saved to a save file, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVFLIB"></a>
<h3>CL var for SAVFLIB (10) (SAVFLIB)</h3>
<p>Specifies a 10-character variable used to return the name of the library that contains the save file if the object was saved to a save file. If the object is not saved to a save file, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SAVLABEL"></a>
<h3>CL var for SAVLABEL (17) (SAVLABEL)</h3>
<p>Specifies a 17-character variable used to return the file label used when the object was saved. If the object is not saved to tape, to diskette, or to an optical volume, the variable is returned blank. The value returned corresponds to the value specified for the LABEL parameter on the command used to save the object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SRCF"></a>
<h3>CL var for SRCF (10) (SRCF)</h3>
<p>Specifies a 10-character variable used to return the name of the source file that was used to create the object. If no source file was used to create the object, the variable is returned blank. For ILE *PGM and *SRVPGM objects, the source file and member are blank. The source file information is stored with the *MODULE object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SRCFLIB"></a>
<h3>CL var for SRCFLIB (10) (SRCFLIB)</h3>
<p>Specifies a 10-character variable used to return the name of the library that contains the source file that was used to create the object. If no source file is used to create the object, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SRCMBR"></a>
<h3>CL var for SRCMBR (10) (SRCMBR)</h3>
<p>Specifies a 10-character variable used to return the name of the member in the source file (SRCF parameter). If no source file is used to create the object, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SRCDATE"></a>
<h3>CL var for SRCDATE (13) (SRCDATE)</h3>
<p>Specifies a 13-character variable used to return the date and time the member in the source file was last updated. The variable is returned in the same format as the CRTDATE parameter or is returned blank if the member is not updated.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SYSLVL"></a>
<h3>CL var for SYSLVL (9) (SYSLVL)</h3>
<p>Specifies a 9-character variable used to return the level of the operating system when the object was created. The variable is returned with a 3-character version level starting in character position 1, a 3-character release level starting in character position 4, and a 3-character modification level starting in character position 7. The first character of the version level is always the letter 'V'; the first character of the release level is always the letter 'R'; the first character of the modification level is always the letter 'M'.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.COMPILER"></a>
<h3>CL var for COMPILER (16) (COMPILER)</h3>
<p>Specifies a 16-character variable used to return the licensed program identifier, version level, release level, and modification level of the compiler. The variable is returned with the 7-character program identifier starting in character position 1, the 3-character version level in character position 8, the 3-character release level in character position 11, and the 3-character modification level in character position 14. The first character of the version level is always the letter 'V'; the first character of the release level is always the letter 'R'; the first character of the modification level is always the letter 'M'. If no compiler was used, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.OBJLVL"></a>
<h3>CL var for OBJLVL (8) (OBJLVL)</h3>
<p>Specifies a 8-character variable used to return the object control level for the created object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.ALWAPICHG"></a>
<h3>CL var for ALWAPICHG (1) (ALWAPICHG)</h3>
<p>Specifies a 1-character variable used to return the Allow Change by Program flag. The following values can be returned:
</p>
<dl>
<dt><b>'1'</b></dt>
<dd>The object can be changed with the Change Object Description (QLICOBJD) API.
</dd>
<dt><b>'0'</b></dt>
<dd>The object cannot be changed with the API.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.APICHG"></a>
<h3>CL var for APICHG (1) (APICHG)</h3>
<p>Specifies a 1-character variable used to return the Changed by Program flag. The following values can be returned:
</p>
<dl>
<dt><b>'1'</b></dt>
<dd>The object has been modified with the Change Object Description (QLICOBJD) API.
</dd>
<dt><b>'0'</b></dt>
<dd>The object has not been changed by the API.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.USRCHG"></a>
<h3>CL var for USRCHG (1) (USRCHG)</h3>
<p>Specifies a 1-character variable used to return whether the object has been modified by the user. The following values can be returned:
</p>
<dl>
<dt><b>'1'</b></dt>
<dd>The object has been modified by the user.
</dd>
<dt><b>'0'</b></dt>
<dd>The object has not been modified by the user.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.LICPGM"></a>
<h3>CL var for LICPGM (16) (LICPGM)</h3>
<p>Specifies a 16-character variable used to return the name, version level, release level, and modification level of the licensed program if the retrieved object is part of a licensed program. The variable is returned with the 7-character name starting in character position 1, the 3-character version level in character position 8, the 3-character release level in character position 11, and the 3-character modification level in character position 14. The first character of the version level is always the letter 'V'; the first character of the release level is always the letter 'R'; the first character of the modification level is always the letter 'M'. If the retrieved object is not part of a licensed program, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.PTF"></a>
<h3>CL var for PTF (10) (PTF)</h3>
<p>Specifies a 10-character variable used to return the Program Temporary Fix number that resulted in the creation of the retrieved object. For user-created objects, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.APAR"></a>
<h3>CL var for APAR (10) (APAR)</h3>
<p>Specifies a 10-character variable used to return the Authorized Program Analysis Report identification (APAR ID). The variable is returned with the APAR ID that caused this object to be patched. If the object has not been changed as a result of an APAR, the variable is returned blank.
</p>
<p>This field is not updated when IBM-supplied Program Temporary Fixes are applied. The field is changed in the following situations:
</p>
<ul>
<li>The default for a command is changed with the Change Command Default (CHGCMDDFT) CL command. The field is set to CHGDFT.
</li>
<li>The Change Object Description (QLICOBJD) API can change this field to any value.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.OBJAUD"></a>
<h3>CL var for OBJAUD (10) (OBJAUD)</h3>
<p>Specifies a 10-character variable used to return the auditing value of the object. 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 *NONE, *USRPRF, *CHANGE, *ALL, and *NOTAVL. See the <b>Object auditing value (OBJAUD)</b> parameter on the Change Object Audit (CHGOBJAUD) command for more information.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.OBJSIG"></a>
<h3>CL var for OBJSIG (1) (OBJSIG)</h3>
<p>Specifies a 1-character variable used to return whether the object has a digital signature. The following values can be returned:
</p>
<dl>
<dt><b>'1'</b></dt>
<dd>The object has a digital signature.
</dd>
<dt><b>'0'</b></dt>
<dd>The object does not have a digital signature.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.SYSSIG"></a>
<h3>CL var for SYSSIG (1) (SYSSIG)</h3>
<p>Specifies a 1-character variable used to return whether the object is signed by a source that is trusted by the system. The following values can be returned:
</p>
<dl>
<dt><b>'1'</b></dt>
<dd>The object is signed by a source that is trusted by the system. If the object has multiple signatures, at least one of the signatures came from a source that is trusted by the system.
</dd>
<dt><b>'0'</b></dt>
<dd>None of the object signatures came from a source that is trusted by the system.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.MLTSIG"></a>
<h3>CL var for MLTSIG (1) (MLTSIG)</h3>
<p>Specifies a 1-character variable used to return whether the object has more than one digital signature. The following values can be returned:
</p>
<dl>
<dt><b>'1'</b></dt>
<dd>The object has more than one digital signature. If the SYSSIG parameter has a value of '1', at least one of the signatures is from a source trusted by the system.
</dd>
<dt><b>'0'</b></dt>
<dd>The object has only one digital signature, or does not have a digital signature. Refer to the OBJSIG parameter to determine whether the object has a digital signature.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.JRNSTS"></a>
<h3>CL var for JRNSTS (1) (JRNSTS)</h3>
<p>Specifies a 1-character variable used to return the current journaling status of the object. The following values can be returned:
</p>
<dl>
<dt><b>'1'</b></dt>
<dd>The object is currently being journaled.
</dd>
<dt><b>'0'</b></dt>
<dd>The object is currently not being journaled.
</dd>
</dl>
<p>
<b>Note: </b>Other journal fields may contain data even though the object is not currently being journaled.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.JRN"></a>
<h3>CL var for JRN (10) (JRN)</h3>
<p>Specifies a 10-character variable used to return the name of the current or last journal. If the object has never been journaled, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.JRNLIB"></a>
<h3>CL var for JRNLIB (10) (JRNLIB)</h3>
<p>Specifies a 10-character variable used to return the name of the library that contains the journal. If the object has never been journaled, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.JRNIMG"></a>
<h3>CL var for JRNIMG (1) (JRNIMG)</h3>
<p>Specifies a 1-character a variable used to return the journal image information. The following values can be returned dependent upon what images are generated for changes to the object:
</p>
<dl>
<dt><b>'0'</b></dt>
<dd>Only <i>after</i> images are written to the journal for changes to the object.
</dd>
<dt><b>'1'</b></dt>
<dd>Both <i>before</i> and <i>after</i> images are written to the journal for changes to the object.
</dd>
</dl>
<p>If the object has never been journaled, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.JRNOMTE"></a>
<h3>CL var for JRNOMTE (1) (JRNOMTE)</h3>
<p>Specifies 1-character variable used to return information regarding journal entries to be omitted. The following values can be returned for the journal entries to be omitted:
</p>
<dl>
<dt><b>'1'</b></dt>
<dd><i>open</i> and <i>close</i> operations on the specified objects do not generate <i>open</i> and <i>close</i> journal entries.
</dd>
<dt><b>'0'</b></dt>
<dd>No journal entries are omitted.
</dd>
</dl>
<p>If the object has never been journaled, the variable is returned blank.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.JRNSTRDATE"></a>
<h3>CL var for JRNSTRDATE (13) (JRNSTRDATE)</h3>
<p>Specifies a 13-character variable used to return the date and time journaling was last started. The value is returned in the same format as the CRTDATE parameter or is returned blank if the object has never been journaled.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.STRJRNRCV"></a>
<h3>CL var for STRJRNRCV (10) (STRJRNRCV)</h3>
<p>Specifies a 10-character variable used to return the name of the oldest journal receiver needed to successfully use the Apply Journaled Changes (APYJRNCHG) or Remove Journaled Changes (RMVJRNCHG) command. This field will be blank if the object has never been journaled.
</p>
<p>For a file object, the journal receiver will contain the entry representing the start-of-the-save operation. However, if there are members within the file that contain partial transactions, then those members may require an earlier journal receiver. Use the Display File Description (DSPFD) command to determine the partial transaction state of the members of the file.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.JRNRCVLIB"></a>
<h3>CL var for JRNRCVLIB (10) (JRNRCVLIB)</h3>
<p>Specifies a 10-character variable used to return the name of the library that contains the starting journal receiver. This field will be blank if the object has never been journaled.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.RCVLIBASP"></a>
<h3>CL var for RCVLIBASP (10) (RCVLIBASP)</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 that contains the starting journal receiver. This field will be blank if the object has never been journaled. 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="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVOBJD.RCVLIBGRP"></a>
<h3>CL var for RCVLIBGRP (10) (RCVLIBGRP)</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 that contains the starting journal receiver. The ASP group name is the name of the primary ASP within the ASP group. The value returned may be the same as the value returned for the RCVLIBASP parameter. This field will be blank if the object has never been journaled. 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="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVOBJD.COMMAND.EXAMPLES">Examples</a> </h3>
<p>Jane Brown enters the following command to create a library:
</p>
<p>
<pre>
CRTLIB LIB(PGMLIB) TYPE(*PROD)
TEXT('Library for test programs')
</pre>
</p>
<p>Later, Jane, or anyone else with the proper authority, can retrieve the attributes of the library in a CL program as shown below:
</p>
<p>
<pre>
DCL &amp;CRTDATE *CHAR 13
DCL &amp;OWN *CHAR 10
DCL &amp;RTNLIB *CHAR 10
DCL &amp;OBJASPDEV *CHAR 10
:
RTVOBJD OBJ(*LIBL/PGMLIB) OBJTYPE(*LIB) TEXT(&amp;TEXT) +
CRTDATE(&amp;CRTDATE) OWNER(&amp;OWN) +
RTNLIB(&amp;RTNLIB) OBJASPDEV(&amp;OBJASPDEV)
</pre>
</p>
<p>The values returned in the variables of the CL program are shown below:
</p>
<p>
<pre>
&amp;TEXT = Library for test programs
&amp;CRTDATE = 0900211130000
&amp;OWN = JBROWN
&amp;RTNLIB = QSYS
&amp;OBJASPDEV = *SYSBAS
</pre>
</p>
<p>The value returned in the variable &amp;CRTDATE indicates that PGMLIB was created on the eleventh day of February, 1990, at 1300 hours. The value returned in the variable &amp;OWN indicates that the library was created by user profile JBROWN. The value returned in the variable &amp;RTNLIB indicates that PGMLIB is in library QSYS. The value returned in the variable &amp;OBJASPDEV indicates that storage for PGMLIB is allocated from *SYSBAS which includes the system auxiliary storage pool (ASP 1) and any defined basic user ASPs (ASPs 2-32).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVOBJD.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPFB8ED</b></dt>
<dd>Device description &amp;1 not correct for operation.
</dd>
<dt><b>CPF2115</b></dt>
<dd>Object &amp;1 in &amp;2 type *&amp;3 damaged.
</dd>
<dt><b>CPF2150</b></dt>
<dd>Object information function failed.
</dd>
<dt><b>CPF2151</b></dt>
<dd>Operation failed for &amp;2 in &amp;1 type *&amp;3.
</dd>
<dt><b>CPF2173</b></dt>
<dd>Value for ASPDEV not valid with special value for library.
</dd>
<dt><b>CPF218C</b></dt>
<dd>&amp;1 not a primary or secondary ASP.
</dd>
<dt><b>CPF218D</b></dt>
<dd>&amp;1 not a primary ASP when *ASPGRP specified.
</dd>
<dt><b>CPF2451</b></dt>
<dd>Message queue &amp;1 is allocated to another job.
</dd>
<dt><b>CPF3202</b></dt>
<dd>File &amp;1 in library &amp;2 in use.
</dd>
<dt><b>CPF3203</b></dt>
<dd>Cannot allocate object for file &amp;1 in &amp;2.
</dd>
<dt><b>CPF36F7</b></dt>
<dd>Message queue QSYSOPR is allocated to another job.
</dd>
<dt><b>CPF980B</b></dt>
<dd>Object &amp;1 in library &amp;2 not available.
</dd>
<dt><b>CPF9801</b></dt>
<dd>Object &amp;2 in library &amp;3 not found.
</dd>
<dt><b>CPF9802</b></dt>
<dd>Not authorized to object &amp;2 in &amp;3.
</dd>
<dt><b>CPF9803</b></dt>
<dd>Cannot allocate object &amp;2 in library &amp;3.
</dd>
<dt><b>CPF9807</b></dt>
<dd>One or more libraries in library list deleted.
</dd>
<dt><b>CPF9808</b></dt>
<dd>Cannot allocate one or more libraries on library list.
</dd>
<dt><b>CPF9810</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF9811</b></dt>
<dd>Program &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF9812</b></dt>
<dd>File &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF9814</b></dt>
<dd>Device &amp;1 not found.
</dd>
<dt><b>CPF9820</b></dt>
<dd>Not authorized to use library &amp;1.
</dd>
<dt><b>CPF9821</b></dt>
<dd>Not authorized to program &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9822</b></dt>
<dd>Not authorized to file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9825</b></dt>
<dd>Not authorized to device &amp;1.
</dd>
<dt><b>CPF9830</b></dt>
<dd>Cannot assign library &amp;1.
</dd>
<dt><b>CPF9831</b></dt>
<dd>Cannot assign device &amp;1.
</dd>
<dt><b>CPF9833</b></dt>
<dd>*CURASPGRP or *ASPGRPPRI specified and thread has no ASP group.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVOBJD.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink