| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
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.
If the object being changed is currently journaled, an entry is deposited to the journal recording the change. Use the Display Object Description (DSPOBJD) command to display journal information for the object.
Note: For additional information regarding journaling, see the Journal management topic collection in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.
Restrictions:
Note: If you do not specify at least one of the Text 'description' (TEXT) or Days used count (USECOUNT) parameters, completion message CPC2105 is sent to indicate that the object was not changed.
| Top |
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| OBJ | Object | Qualified object name | Required, Key, Positional 1 |
| Qualifier 1: Object | Generic name, name, *ALL | ||
| Qualifier 2: Library | Name, *LIBL, *USRLIBL, *CURLIB, *ALL, *ALLUSR | ||
| OBJTYPE | Object type | *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, *SQLXSR, *SRVPGM, *SSND, *SVRSTG, *S36, *TBL, *TIMZON, *USRIDX, *USRPRF, *USRQ, *USRSPC, *VLDL, *WSCST | Required, Key, Positional 2 |
| TEXT | Text 'description' | Character value, *SAME, *BLANK | Optional, Positional 3 |
| USECOUNT | Days used count | *NORESET, *RESET | Optional |
| Top |
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.
Note: 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.
This is a required parameter.
Qualifier 1: Object
Qualifier 2: Library
#CGULIB #DSULIB #SEULIB #COBLIB #RPGLIB #DFULIB #SDALIB
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:
QDSNX QRCLxxxxx QUSRDIRDB QUSRVI QGPL QSRVAGT QUSRIJS QUSRVxRxMx QGPL38 QSYS2 QUSRINFSKR QMGTC QSYS2xxxxx QUSRNOTES QMGTC2 QS36F QUSROND QMPGDATA QUSER38 QUSRPOSGS QMQMDATA QUSRADSM QUSRPOSSA QMQMPROC QUSRBRM QUSRPYMSVR QPFRDATA QUSRDIRCF QUSRRDARS QRCL QUSRDIRCL QUSRSYS
| Top |
Specifies the object type of the objects to be changed.
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 topic collection in the Programming category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.
This is a required parameter.
| Top |
Specifies the text that briefly describes the object.
| Top |
Specifies whether the days used count for the objects is to be reset. For more details on usage information, see "Objects and libraries" in the CL topic collection in the Programming category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.
Object usage information is not updated for all object types. If usage information is not updated for the specified object type and *RESET was specified, the days used count is not updated and an error message is not sent. Use the Display Object Description (DSPOBJD) command for the object being changed to determine if usage data is collected for the object.
Note: For database files, the days used count and reset date are updated for all members in the file.
| Top |
CHGOBJD OBJ(LIB1/DA1) OBJTYPE(*DTAARA)
TEXT('NEW TEXT FOR DA1')
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.
| Top |
*ESCAPE Messages
| Top |