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

316 lines
12 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>Change Object Description (CHGOBJD)</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="CHGOBJD.Top_Of_Page"></a>
<h2>Change Object Description (CHGOBJD)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#CHGOBJD.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CHGOBJD.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CHGOBJD.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CHGOBJD"></a>
<p>The Change Object Description (CHGOBJD) command can change the text description of an object or reset the days used count to 0 (zero) for the specified objects.
</p>
<p>If the object being changed is currently journaled, an entry is written to the journal recording the change.
</p>
<p>
<b>Note: </b>For additional information regarding journaling, see the Journal Management information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>For file objects, you must have object operational (*OBJOPR) and object management (*OBJMGT) authorities for the object to be changed.
</li>
<li>For non-file objects, you must have object management (*OBJMGT) authority for the object to be changed.
</li>
<li>You must have execute (*EXECUTE) authority for the library where the object is located.
</li>
</ol>
<p>
<b>Note: </b>If you do not specify at least one of the <b>Text 'description' (TEXT)</b> or <b>Days used count (USECOUNT)</b> parameters, completion message CPC2105 is sent to indicate that the object was not changed.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CHGOBJD.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="#CHGOBJD.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, Key, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Object</td>
<td valign="top"><i>Generic name, name</i>, *ALL</td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *USRLIBL, *CURLIB, *ALL, *ALLUSR</td>
</tr><tr>
<td valign="top"><a href="#CHGOBJD.OBJTYPE"><b>OBJTYPE</b></a></td>
<td valign="top">Object type</td>
<td valign="top">*ALL, *ALRTBL, *AUTL, *BNDDIR, *CFGL, *CHTFMT, *CLD, *CLS, *CMD, *CNNL, *COSD, *CRG, *CRQD, *CSI, *CSPMAP, *CSPTBL, *CTLD, *DEVD, *DTAARA, *DTADCT, *DTAQ, *EDTD, *EXITRG, *FCT, *FILE, *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, Key, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#CHGOBJD.TEXT"><b>TEXT</b></a></td>
<td valign="top">Text 'description'</td>
<td valign="top"><i>Character value</i>, <b><u>*SAME</u></b>, *BLANK</td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#CHGOBJD.USECOUNT"><b>USECOUNT</b></a></td>
<td valign="top">Days used count</td>
<td valign="top"><b><u>*NORESET</u></b>, *RESET</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CHGOBJD.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CHGOBJD.OBJ"></a>
<h3>Object (OBJ)</h3>
<p>Specifies the object whose description is to be changed. If qualifier 2 is not specified, *LIBL is searched to find the specified object. A library name can be specified for qualifier 2 to ensure that the correct object is changed.
</p>
<p>
<b>Note: </b>To change the object description for objects of type *DEVD, you should first use the Allocate Object (ALCOBJ) command to obtain an *EXCLRD lock state on the device description. If this is not done, a CPF2114 message is sent, which indicates that the device description is locked. The ALCOBJ command does not have to be used if you are already signed on the display device for which the description is to be changed.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Object</b>
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>All objects in the libraries identified in the library qualifier that are of the types specified for the <b>Object type (OBJTYPE)</b> parameter are to be changed.
</dd>
<dt><b><i>generic-name</i></b></dt>
<dd>Specify the generic name of the objects to be changed. A generic name is specified as a character string that contains one or more characters followed by an asterisk (*). A generic name specifies all objects that have names with the same prefix as the generic object name for which you have the proper authority.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the objects to be changed.
</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.
</dd>
</dl>
<dl>
<dt><b>*USRLIBL</b></dt>
<dd>If a current library entry exists in the library list for the current thread, the current library and the libraries in the user portion of the library list are searched. If there is no current library entry, only the libraries in the user portion of the library list are searched.
</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.
</dd>
</dl>
<dl>
<dt><b>*ALL</b></dt>
<dd>All the libraries in the thread's library name space, including QSYS, are searched.
</dd>
</dl>
<dl>
<dt><b>*ALLUSR</b></dt>
<dd>All user libraries are searched. All libraries with names that do not begin with the letter Q are searched except for the following:
<p>
<pre>
#CGULIB #DSULIB #SEULIB
#COBLIB #RPGLIB
#DFULIB #SDALIB
</pre>
</p>
<p>Although the following Qxxx libraries are provided by IBM, they typically contain user data that changes frequently. Therefore, these libraries are considered user libraries and are also searched:
</p>
<p>
<pre>
QDSNX QRCLxxxxx QUSRIJS QUSRVxRxMx
QGPL QSRVAGT QUSRINFSKR
QGPL38 QSYS2 QUSRNOTES
QMGTC QSYS2xxxxx QUSROND
QMGTC2 QS36F QUSRPOSGS
QMPGDATA QUSER38 QUSRPOSSA
QMQMDATA QUSRADSM QUSRPYMSVR
QMQMPROC QUSRBRM QUSRRDARS
QPFRDATA QUSRDIRCL QUSRSYS
QRCL QUSRDIRDB QUSRVI
</pre>
</p>
<ol>
<li>'xxxxx' is the number of a primary auxiliary storage pool (ASP).
</li>
<li>A different library name, in the format QUSRVxRxMx, can be created by the user for each previous release supported by IBM to contain any user commands to be compiled in a CL program for the previous release. For the QUSRVxRxMx user library, VxRxMx is the version, release, and modification level of a previous release that IBM continues to support.
</li>
</ol>
</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="#CHGOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGOBJD.OBJTYPE"></a>
<h3>Object type (OBJTYPE)</h3>
<p>Specifies the object type of the objects to be changed.
</p>
<p>To see a complete list of object types when prompting this command, position the cursor on the field for this parameter and press F4 (Prompt). For a description of the object types, see "Object types" in the CL concepts and reference topic in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b><i>object-type</i></b></dt>
<dd>Specify the type of objects to be changed.
</dd>
<dt><b>*ALL</b></dt>
<dd>All types of objects that have the name and library specified for the <b>Object (OBJ)</b> parameter and for which you have authority are to be changed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGOBJD.TEXT"></a>
<h3>Text 'description' (TEXT)</h3>
<p>Specifies the text that briefly describes the object.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The text does not change.
</dd>
<dt><b>*BLANK</b></dt>
<dd>The text is set to blanks.
</dd>
<dt><b><i>'description'</i></b></dt>
<dd>Specify no more than 50 characters, enclosed in apostrophes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGOBJD.USECOUNT"></a>
<h3>Days used count (USECOUNT)</h3>
<p>Specifies whether the days used count for the objects is to be reset.
</p>
<dl>
<dt><b><u>*NORESET</u></b></dt>
<dd>The days used count for the objects is not to be reset.
</dd>
<dt><b>*RESET</b></dt>
<dd>The days used count for the objects is to be reset to zero (0). The reset date is to be updated to the current system date.
<p>
<b>Note: </b>For database files, the days used count and reset date are updated for all members in the file.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CHGOBJD.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
CHGOBJD OBJ(LIB1/DA1) OBJTYPE(*DTAARA)
TEXT('NEW TEXT FOR DA1')
</pre>
</p>
<p>This command changes the text description of the data area named DA1 located in the library LIB1 to the value specified by the TEXT parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGOBJD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CHGOBJD.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF2105</b></dt>
<dd>Object &amp;1 in &amp;2 type *&amp;3 not found.
</dd>
<dt><b>CPF2110</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF2113</b></dt>
<dd>Cannot allocate library &amp;1.
</dd>
<dt><b>CPF2114</b></dt>
<dd>Cannot allocate object &amp;1 in &amp;2 type *&amp;3.
</dd>
<dt><b>CPF2123</b></dt>
<dd>No objects of specified name or type exist in library &amp;2.
</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>CPF2176</b></dt>
<dd>Library &amp;1 damaged.
</dd>
<dt><b>CPF2182</b></dt>
<dd>Not authorized to library &amp;1.
</dd>
<dt><b>CPF2189</b></dt>
<dd>Not authorized to object &amp;1 in &amp;2 type *&amp;3.
</dd>
<dt><b>CPF2195</b></dt>
<dd>Text value must be *SAME.
</dd>
<dt><b>CPF2196</b></dt>
<dd>Library value cannot be a special value.
</dd>
<dt><b>CPF2198</b></dt>
<dd>Days used count field not reset to 0 for some objects.
</dd>
<dt><b>CPF2451</b></dt>
<dd>Message queue &amp;1 is allocated to another job.
</dd>
<dt><b>CPF36F7</b></dt>
<dd>Message queue QSYSOPR is allocated to another job.
</dd>
<dt><b>CPF7304</b></dt>
<dd>File &amp;1 in &amp;2 not changed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGOBJD.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>