The Retrieve Object Description (RTVOBJD) command retrieves the description of a specific object to a CL program or REXX procedure.

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.

Restrictions:

1. You must have execute (*EXECUTE) authority for the library.
2. 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.
3. You must have either all object (*ALLOBJ) or audit (*AUDIT) special authority to retrieve a value other than *NOTAVL for the OBJAUD parameter.

Parameters

Keyword	Description	Choices	Notes
OBJ	Object	Qualified object name	Required, Positional 1
	Qualifier 1: Object	Name
	Qualifier 2: Library	Name, *LIBL, *CURLIB
OBJTYPE	Object type	*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	Required, Positional 2
ASPDEV	ASP device	Single values: *, *ALLAVL, *CURASPGRP, *SYSBAS Other values: Element list	Optional
	Element 1: Device	Name
	Element 2: Search type	*ASP, *ASPGRP
RTNLIB	CL var for RTNLIB (10)	Character value	Optional
OBJATR	CL var for OBJATR (10)	Character value	Optional
USRDFNATR	CL var for USRDFNATR (10)	Character value	Optional
TEXT	CL var for TEXT (50)	Character value	Optional
OWNER	CL var for OWNER (10)	Character value	Optional
PGP	CL var for PGP (10)	Character value	Optional
ASP	CL var for ASP (2 0)	Decimal number	Optional
LIBASP	CL var for LIBASP (5 0)	Decimal number	Optional
OBJASPDEV	CL var for OBJASPDEV (10)	Character value	Optional
OBJASPGRP	CL var for OBJASPGRP (10)	Character value	Optional
LIBASPDEV	CL var for LIBASPDEV (10)	Character value	Optional
LIBASPGRP	CL var for LIBASPGRP (10)	Character value	Optional
OVFASP	CL var for OVFASP (1)	Character value	Optional
CRTDATE	CL var for CRTDATE (13)	Character value	Optional
CHGDATE	CL var for CHGDATE (13)	Character value	Optional
SAVDATE	CL var for SAVDATE (13)	Character value	Optional
SAVACTDATE	CL var for SAVACTDATE (13)	Character value	Optional
RSTDATE	CL var for RSTDATE (13)	Character value	Optional
CRTUSER	CL var for CRTUSER (10)	Character value	Optional
CRTSYSTEM	CL var for CRTSYSTEM (8)	Character value	Optional
OBJDMN	CL var for OBJDMN (2)	Character value	Optional
USEUPD	CL var for USEUPD (1)	Character value	Optional
USEDATE	CL var for USEDATE (7)	Character value	Optional
USECOUNT	CL var for USECOUNT (5 0)	Decimal number	Optional
RESETDATE	CL var for RESETDATE (7)	Character value	Optional
STG	CL var for STG (10)	Character value	Optional
CPR	CL var for CPR (1)	Character value	Optional
SIZE	CL var for SIZE (15 0)	Decimal number	Optional
SPCSIZE	CL var for SPCSIZE (15 0)	Decimal number	Optional
SPCALIGN	CL var for SPCALIGN (1)	Character value	Optional
SAVSIZE	CL var for SAVSIZE (15 0)	Decimal number	Optional
SAVCMD	CL var for SAVCMD (10)	Character value	Optional
SAVSEQNBR	CL var for SAVSEQNBR (4 0)	Decimal number	Optional
SAVLRGSEQ	CL var for SAVLRGSEQ (10 0)	Decimal number	Optional
SAVVOL	CL var for SAVVOL (71)	Character value	Optional
SAVDEV	CL var for SAVDEV (10)	Character value	Optional
SAVF	CL var for SAVF (10)	Character value	Optional
SAVFLIB	CL var for SAVFLIB (10)	Character value	Optional
SAVLABEL	CL var for SAVLABEL (17)	Character value	Optional
SRCF	CL var for SRCF (10)	Character value	Optional
SRCFLIB	CL var for SRCFLIB (10)	Character value	Optional
SRCMBR	CL var for SRCMBR (10)	Character value	Optional
SRCDATE	CL var for SRCDATE (13)	Character value	Optional
SYSLVL	CL var for SYSLVL (9)	Character value	Optional
COMPILER	CL var for COMPILER (16)	Character value	Optional
OBJLVL	CL var for OBJLVL (8)	Character value	Optional
ALWAPICHG	CL var for ALWAPICHG (1)	Character value	Optional
APICHG	CL var for APICHG (1)	Character value	Optional
USRCHG	CL var for USRCHG (1)	Character value	Optional
LICPGM	CL var for LICPGM (16)	Character value	Optional
PTF	CL var for PTF (10)	Character value	Optional
APAR	CL var for APAR (10)	Character value	Optional
OBJAUD	CL var for OBJAUD (10)	Character value	Optional
OBJSIG	CL var for OBJSIG (1)	Character value	Optional
SYSSIG	CL var for SYSSIG (1)	Character value	Optional
MLTSIG	CL var for MLTSIG (1)	Character value	Optional
JRNSTS	CL var for JRNSTS (1)	Character value	Optional
JRN	CL var for JRN (10)	Character value	Optional
JRNLIB	CL var for JRNLIB (10)	Character value	Optional
JRNIMG	CL var for JRNIMG (1)	Character value	Optional
JRNOMTE	CL var for JRNOMTE (1)	Character value	Optional
JRNSTRDATE	CL var for JRNSTRDATE (13)	Character value	Optional
STRJRNRCV	CL var for STRJRNRCV (10)	Character value	Optional
JRNRCVLIB	CL var for JRNRCVLIB (10)	Character value	Optional
RCVLIBASP	CL var for RCVLIBASP (10)	Character value	Optional
RCVLIBGRP	CL var for RCVLIBGRP (10)	Character value	Optional

Top

Object (OBJ)

Specifies the object for which you want to retrieve information.

This is a required parameter.

Qualifier 1: Object

name

Specify the name of the object for which the description is to be retrieved.

Qualifier 2: Library

*LIBL

All libraries in the library list for the current thread are searched until the first match is found. If the ASP device (ASPDEV) parameter is specified when this value is used, ASPDEV(*) is the only valid value.

*CURLIB

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 ASP device (ASPDEV) parameter is specified when this value is used, ASPDEV(*) is the only valid value.

name

Specify the name of the library to be searched.

Object type (OBJTYPE)

Specifies the type of the object for which you want to retrieve the information.

This is a required parameter.

object-type

Specify the type of the object for which information is to be retrieved.

ASP device (ASPDEV)

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 Object (OBJ) 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.

Single values

*

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.

*ALLAVL

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').

*CURASPGRP

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.

*SYSBAS

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.

Element 1: Device

name

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.

Note: 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.

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.

Element 2: Search type

Specifies whether the single ASP device or the entire ASP group named in element 1 is to be searched.

*ASP

Only the single auxiliary storage pool (ASP) device named in element 1 is to be searched.

*ASPGRP

The entire group of the primary auxiliary storage pool (ASP) device named in element 1 is to be searched.

CL var for RTNLIB (10) (RTNLIB)

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 Object (OBJ) 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.

CL var for OBJATR (10) (OBJATR)

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.

CL var for USRDFNATR (10) (USRDFNATR)

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.

CL var for TEXT (50) (TEXT)

Specifies a 50-character CL variable used to return the text description of the object.

CL var for OWNER (10) (OWNER)

Specifies a 10-character variable used to return the name of the owner of the object.

CL var for PGP (10) (PGP)

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.

CL var for ASP (2 0) (ASP)

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:

1

The object is in the system auxiliary storage pool.

2-32

The object is in a basic user auxiliary storage pool.

-1

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.

CL var for LIBASP (5 0) (LIBASP)

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:

1

The library is in the system auxiliary storage pool.

2-32

The library is in a basic user auxiliary storage pool.

-1

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.

CL var for OBJASPDEV (10) (OBJASPDEV)

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:

*N

The name of the ASP device cannot be determined.

*SYSBAS

The object is in the system ASP (ASP 1) or in a basic user ASP (ASPs 2-32).

CL var for OBJASPGRP (10) (OBJASPGRP)

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:

*N

The name of the primary ASP device cannot be determined.

*SYSBAS

The object is in the system ASP (ASP 1) or in a basic user ASP (ASPs 2-32).

CL var for LIBASPDEV (10) (LIBASPDEV)

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:

*N

The name of the ASP device cannot be determined.

*SYSBAS

The library is in the system ASP (ASP 1) or in a basic user ASP (ASPs 2-32).

CL var for LIBASPGRP (10) (LIBASPGRP)

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:

*N

The name of the primary ASP device cannot be determined.

*SYSBAS

The object is in the system ASP (ASP 1) or in a basic user ASP (ASPs 2-32).

CL var for OVFASP (1) (OVFASP)

Specifies a 1-character variable used to return the Object Overflowed auxiliary storage pool (ASP) flag.

'1'

The object overflowed the ASP in which it resides.

'0'

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).

CL var for CRTDATE (13) (CRTDATE)

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.

CL var for CHGDATE (13) (CHGDATE)

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.

CL var for SAVDATE (13) (SAVDATE)

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.

CL var for SAVACTDATE (13) (SAVACTDATE)

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.

CL var for RSTDATE (13) (RSTDATE)

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.

CL var for CRTUSER (10) (CRTUSER)

Specifies a 10-character variable used to return the name of the user that created the object.

CL var for CRTSYSTEM (8) (CRTSYSTEM)

Specifies an 8-character variable used to return the name of the system on which the object was created.

CL var for OBJDMN (2) (OBJDMN)

Specifies a 2-character variable used to return the object domain value for the object. The following values can be returned:

*U

The object is a user domain object.

*S

The object is a system domain object.

CL var for USEUPD (1) (USEUPD)

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:

Y

Object usage information is updated for this object type.

N

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).

CL var for USEDATE (7) (USEDATE)

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.

CL var for USECOUNT (5 0) (USECOUNT)

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.

CL var for RESETDATE (7) (RESETDATE)

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.

CL var for STG (10) (STG)

Specifies a 10-character variable used to return the storage status of the object data. The following values can be returned:

*FREE

The object data has been freed and the object is suspended.

*KEEP

The object data has not been freed and the object has not been suspended.

CL var for CPR (1) (CPR)

Specifies a 1-character variable used to return the compression status of the object. The following values can be returned:

Y

The object is compressed.

X

The object is ineligible for compression.

N

The object is permanently decompressed.

T

The object is temporarily decompressed.

F

The object is eligible for compression but is saved with storage freed.

CL var for SIZE (15 0) (SIZE)

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.

CL var for SPCSIZE (15 0) (SPCSIZE)

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.

CL var for SPCALIGN (1) (SPCALIGN)

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:

'0'

The space associated with the object has not been optimally aligned.

'1'

The space associated with the object has been optimally aligned.

'2'

There is not a space associated with the object.

CL var for SAVSIZE (15 0) (SAVSIZE)

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.

CL var for SAVCMD (10) (SAVCMD)

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.

CL var for SAVSEQNBR (4 0) (SAVSEQNBR)

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.

CL var for SAVLRGSEQ (10 0) (SAVLRGSEQ)

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.

CL var for SAVVOL (71) (SAVVOL)

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.

CL var for SAVDEV (10) (SAVDEV)

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:

• *SAVF for a save file
• *DKT for a diskette
• *TAP for a tape
• *OPT for an optical volume
• The variable is returned blank if the object was not saved.

CL var for SAVF (10) (SAVF)

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.

CL var for SAVFLIB (10) (SAVFLIB)

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.

CL var for SAVLABEL (17) (SAVLABEL)

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.

CL var for SRCF (10) (SRCF)

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.

CL var for SRCFLIB (10) (SRCFLIB)

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.

CL var for SRCMBR (10) (SRCMBR)

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.

CL var for SRCDATE (13) (SRCDATE)

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.

CL var for SYSLVL (9) (SYSLVL)

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'.

CL var for COMPILER (16) (COMPILER)

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.

CL var for OBJLVL (8) (OBJLVL)

Specifies a 8-character variable used to return the object control level for the created object.

CL var for ALWAPICHG (1) (ALWAPICHG)

Specifies a 1-character variable used to return the Allow Change by Program flag. The following values can be returned:

'1'

The object can be changed with the Change Object Description (QLICOBJD) API.

'0'

The object cannot be changed with the API.

CL var for APICHG (1) (APICHG)

Specifies a 1-character variable used to return the Changed by Program flag. The following values can be returned:

'1'

The object has been modified with the Change Object Description (QLICOBJD) API.

'0'

The object has not been changed by the API.

CL var for USRCHG (1) (USRCHG)

Specifies a 1-character variable used to return whether the object has been modified by the user. The following values can be returned:

'1'

The object has been modified by the user.

'0'

The object has not been modified by the user.

CL var for LICPGM (16) (LICPGM)

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.

CL var for PTF (10) (PTF)

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.

CL var for APAR (10) (APAR)

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.

This field is not updated when IBM-supplied Program Temporary Fixes are applied. The field is changed in the following situations:

• The default for a command is changed with the Change Command Default (CHGCMDDFT) CL command. The field is set to CHGDFT.
• The Change Object Description (QLICOBJD) API can change this field to any value.

CL var for OBJAUD (10) (OBJAUD)

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 Object auditing value (OBJAUD) parameter on the Change Object Audit (CHGOBJAUD) command for more information.

CL var for OBJSIG (1) (OBJSIG)

Specifies a 1-character variable used to return whether the object has a digital signature. The following values can be returned:

'1'

The object has a digital signature.

'0'

The object does not have a digital signature.

CL var for SYSSIG (1) (SYSSIG)

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:

'1'

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.

'0'

None of the object signatures came from a source that is trusted by the system.

CL var for MLTSIG (1) (MLTSIG)

Specifies a 1-character variable used to return whether the object has more than one digital signature. The following values can be returned:

'1'

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.

'0'

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.

CL var for JRNSTS (1) (JRNSTS)

Specifies a 1-character variable used to return the current journaling status of the object. The following values can be returned:

'1'

The object is currently being journaled.

'0'

The object is currently not being journaled.

Note: Other journal fields may contain data even though the object is not currently being journaled.

CL var for JRN (10) (JRN)

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.

CL var for JRNLIB (10) (JRNLIB)

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.

CL var for JRNIMG (1) (JRNIMG)

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:

'0'

Only after images are written to the journal for changes to the object.

'1'

Both before and after images are written to the journal for changes to the object.

If the object has never been journaled, the variable is returned blank.

CL var for JRNOMTE (1) (JRNOMTE)

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:

'1'

open and close operations on the specified objects do not generate open and close journal entries.

'0'

No journal entries are omitted.

If the object has never been journaled, the variable is returned blank.

CL var for JRNSTRDATE (13) (JRNSTRDATE)

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.

CL var for STRJRNRCV (10) (STRJRNRCV)

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.

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.

CL var for JRNRCVLIB (10) (JRNRCVLIB)

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.

CL var for RCVLIBASP (10) (RCVLIBASP)

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:

*N

The name of the ASP device cannot be determined.

*SYSBAS

The library is in the system ASP (ASP 1) or in a basic user ASP (ASPs 2-32).

CL var for RCVLIBGRP (10) (RCVLIBGRP)

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:

*N

The name of the ASP device cannot be determined.

*SYSBAS

The library is in the system ASP (ASP 1) or in a basic user ASP (ASPs 2-32).

Examples

Jane Brown enters the following command to create a library:

CRTLIB   LIB(PGMLIB)  TYPE(*PROD)
         TEXT('Library for test programs')

Later, Jane, or anyone else with the proper authority, can retrieve the attributes of the library in a CL program as shown below:

DCL   &CRTDATE   *CHAR  13
DCL   &OWN       *CHAR  10
DCL   &RTNLIB    *CHAR  10
DCL   &OBJASPDEV *CHAR  10
 :
RTVOBJD   OBJ(*LIBL/PGMLIB) OBJTYPE(*LIB) TEXT(&TEXT)  +
          CRTDATE(&CRTDATE) OWNER(&OWN)                +
          RTNLIB(&RTNLIB) OBJASPDEV(&OBJASPDEV)

The values returned in the variables of the CL program are shown below:

&TEXT      =  Library for test programs
&CRTDATE   =  0900211130000
&OWN       =  JBROWN
&RTNLIB    =  QSYS
&OBJASPDEV =  *SYSBAS

The value returned in the variable &CRTDATE indicates that PGMLIB was created on the eleventh day of February, 1990, at 1300 hours. The value returned in the variable &OWN indicates that the library was created by user profile JBROWN. The value returned in the variable &RTNLIB indicates that PGMLIB is in library QSYS. The value returned in the variable &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).

Error messages

*ESCAPE Messages

CPFB8ED

Device description &1 not correct for operation.

CPF2115

Object &1 in &2 type *&3 damaged.

CPF2150

Object information function failed.

CPF2151

Operation failed for &2 in &1 type *&3.

CPF2173

Value for ASPDEV not valid with special value for library.

CPF218C

&1 not a primary or secondary ASP.

CPF218D

&1 not a primary ASP when *ASPGRP specified.

CPF2451

Message queue &1 is allocated to another job.

CPF3202

File &1 in library &2 in use.

CPF3203

Cannot allocate object for file &1 in &2.

CPF36F7

Message queue QSYSOPR is allocated to another job.

CPF980B

Object &1 in library &2 not available.

CPF9801

Object &2 in library &3 not found.

CPF9802

Not authorized to object &2 in &3.

CPF9803

Cannot allocate object &2 in library &3.

CPF9807

One or more libraries in library list deleted.

CPF9808

Cannot allocate one or more libraries on library list.

CPF9810

Library &1 not found.

CPF9811

Program &1 in library &2 not found.

CPF9812

File &1 in library &2 not found.

CPF9814

Device &1 not found.

CPF9820

Not authorized to use library &1.

CPF9821

Not authorized to program &1 in library &2.

CPF9822

Not authorized to file &1 in library &2.

CPF9825

Not authorized to device &1.

CPF9830

Cannot assign library &1.

CPF9831

Cannot assign device &1.

CPF9833

*CURASPGRP or *ASPGRPPRI specified and thread has no ASP group.