COZZI - Display Object Info (DSPOBJINF)

Parameters

Keyword	Description	Choices	Notes
OBJ	Object name(s)	Values (up to 300 repetitions): Element list	Required, Positional 1
	Element 1: Object	Qualified object name
	Qualifier 1: Object	Generic name, name, ALL, ALLUSR, *IBM
	Qualifier 2: Library	Generic name, name, ALL, ALLUSR, CURLIB, LIBL, *USRLIBL
	Element 2: Object type	Character value, *ALL
INCLUDE	Include objects criteria	Single values: ALL Other values (up to 300 repetitions): Element list*	Optional, Positional 2
	Element 1: Relationship	IF, AND, *OR, IF, AND, OR
	Element 2: Selection field	TGTRLS, CRTDATE, CHGDATE, JRNSTATUS, LASTUSED, LASTUSE, LSTUSED, LSTUSE, OBJATR, OBJATTR, OBJTYPE, OBJTEXT, OBJSIZE, OBJOWN, OWNER, CREATOR, PGMENV, ISSRC, ISSROURCE, CRTSYSNAME, SYSNAME, TGTRLS, CRTDATE, CHGDATE, LASTUSED, LASTUSE, LSTUSED, LSTUSE, OBJOWN, OBJSIZE, OBJATTR, OBJATR, OBJTYPE, JRNSTATUS, TEXT, *CRTUSRPRF, CRTUSRPRF, PGMENV, CRTSYSNAME, SYSNAME
	Element 3: Relational operator	EQ, LT, LE, GT, GE, NE, EQ, LT, LE, GT, GE, NE, *CT, CT
	Element 4: Value	Character value, CURRENT, TRUE, *FALSE
OBJSTS	Object status	Element list	Optional, Positional 3
	Element 1: Select or omit	SELECT, OMIT
	Element 2: Object status	Single values: ALL Other values (up to 5 repetitions): NORMAL, DAMAGED, PARTIAL, LOCKED, AUTHORITY, DMG, PDMG, LCK, AUTH, D, P, L, A
ORDERBY	Order output sequence	Single values: ARRIVAL, NONE Other values (up to 20 repetitions): Element list	Optional, Positional 4
	Element 1: Sequence by field	OBJNAME, OBJLIB, OBJTYPE, OBJATR, TEXT, CRTDATE, LASTCHG, CREATOR, OWNER, SYSNAME, LASTUSED, SYSLVL, COMPILER, OBJLVL, *TGTRLS
	Element 2: Ascending or Descending	ASCEND, DESCEND, ASC, DES, DSC, DESC, A, D
OUTPUT	Output	, PRINT	Optional, Positional 5
OUTQ	Output queue	Single values: JOB Other values: Qualified object name*	Optional, Positional 6
	Qualifier 1: Output queue	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
LPI	Lines per inch (LPI)	8, 3.0, 4.0, 6.0, 7.5, 8.0, 9.0, 12.0	Optional, Positional 7
CPI	Characters per inch (CPI)	18, 5.0, 10.0, 12.0, 13.3, 15.0, 16.7, 18.0, 20.0	Optional, Positional 8
OVRFLW	Overflow line number	1-255, *HALFINCH, .5	Optional, Positional 9

Top

Object name(s) (OBJ)

Specifies the list of object names to be included on the report.

This is a required parameter.

You can specify 300 values for this parameter.

Element 1: Object

Qualifier 1: Object

*ALL: All objects in the specified library are listed.
generic-name: Specify the generic name of the objects to be included on the report.
name: Specify up to 300 distinct object names to be include don the report.

Qualifier 2: Library

*ALL: All libraries are searched for the objects.
*ALLUSR: All user libraries are searched for the objects.
*CURLIB: The current library only is searched for the objects.
*LIBL: The entire library list is searched for the objects.
*USRLIBL: The user-portion of the library list is searched for the objects.
name: Specify the name of the library that is searched for the objects.

Element 2: Object type

*ALL: All object types supported by the DSPOBJINF command are included.
object-type: Specify *PGM, *SRVPGM, *MODULE, *FILE or any other valid IBM i object type.

Include objects criteria (INCLUDE)

Specifies select/omit criteria for the selected objects. Multiple entries may be specified for this parameter to create a compound selection statement.

Single values

*ALL: No INCLUDE options are specified--all objects specified on the OBJ parameter are included in the Report.

Other values (up to 300 repetitions)

Element 1: Relationship

*IF or IF: Specify *IF for the first INCLUDE condition. No other include conditions may specify *IF. Use *AND or *OR for subsequence include entries.
*AND: The object is selected when any prior conditions AND this condition is true.
*OR: The object is selected when any prior conditions OR this condition is true.

Element 2: Selection field

*TGTRLS: The target release for the object is tested.
*CRTDATE: Specify the Object Creation Date in ISO format 'YYYY-MM-DD'.
*CHGDATE: Specify the Object Last Change Date in ISO format 'YYYY-MM-DD'.
*OBJOWN: Specify the user profile of the Objects' owner.
*OWNER: Same as *OBJOWN
*CRTUSRPRF: Specify the name of the user profile that created the objects.
*OBJSIZE: Specify the size of the object to be included. The size (in bytes) may be specified, or symbolic sizes, such as 1GB, 500MB may be used. When GB or MB are used, the size is a multiple of 1024. To specify a symbolic size for bytes vs kilobytes, use just the first letter such as 4G (meaning 4 billion) or 20M (meaning 20,000,000). You may also use xBIL or xMIL (such as 1.5Bil or 2.5Mil) as the symbolic name for billions and millions, respectively.
*PGMENV: Specify the programming environment (ILE, OPM, etc.)
*CRTSYSNAME: Specify the name of the system on which the object was created.
*SYSNAME: Same as *CRTSYSNAME
TGTRLS: Specify the target release for which the object was created. VxRyMz

Element 3: Relational operator

*EQ: Specify the BOOLEAN operator (*EQ, *NE, *GT, *LT, *GE, *LE) used to compare the the value to the control keyword.

Element 4: Value

*CURRENT: For date, system name or user profile keywords, *CURRENT retrieves the the current setting.
character-value: Specify the value to compare to the control keyword. For date values specify them in *ISO format 'YYYY-MM-DD' not standard CL command *JOB format.

Object Status (OBJSTS)

Specifies whether to include or omit objects that are damaged, partially damaged, locked by another job, or when the user of this command is not authorized to the object information.

Select or Omit

*SELECT: The object status is used to include objects on the list. Objects matching the status settings are included on the list.
*OMIT: The object status is used to omit objects from the list. Objects matching the status settings are omitted from the list.

Object Status

*ALL: Objects with any status are returned. Note If *OMIT is specified then *ALL cannot be the only status specified or no list is produced.
*DAMAGED or *DMG: Damaged objects are included or omitted from the list.
*PARTIAL or *PDMG: Partially damaged objects are included or omitted from the list.
*AUTHORTY or *AUT/*AUTH: Objects to which the user running the command does not have authority to read the information normally returned by the QGYOLOBJ API are included or omitted from the list.
*LOCKED or *LCK: Objects that are currently locked by other processes, possible preventing their information from being returned, are included or omitted from the list.

Sort Sequence (ORDERBY)

Specifies the sequence in which records are returned and subsequently printed. Multiple sort fields may be specified along with an indication of Ascending or Descending order for that field.

*NONE or *ARRIVAL

No ORDER BY clause is used to sequence the list of objects. Often the list is proceduced in Object Name sequence when *ARRIVAL or *NONE is specified.

orderby-clause

Specify any valid field by which to sort the object list. The valid choices include:

*OBJNAME: Object name.
*OBJLIB: The library in which the object is located.
*OBJTYPE: The object type such as *PGM, *FILE, *CMD.
*OBJATR: The 10-byte extended Object Attribute, such as "RPGLE" or "PF".
*TEXT: Text description for the object.
*CRTDATE: Object Creation Date/Time.
*LASTCHG: Last time the object was modified/changed.
*CREATOR: User Profile of the user that created the object.
*OWNER: The current Object Owner.
*SYSNAME: The System Name on which the object was created.
*SYSLVL: Release level of the system at the time the object was created.
*COMPILER: Compiler (Tip: Use this to sort by ILE/OPN environment.)
*OBJLVL: OS Release Level created on.
*TGTRLS: Target Release.
*LASTUSED: Date that the object was last used.

Output (OUTPUT)

Specifies where the output is directed. The SPOOLed file is created on the output queue is specified on the OUTQ parameter. The default OUTQ(*JOB) means it is SPOOLed to the output queue associated with the job running this command. When OUTPUT(*) is specified, the SPOOLed file is created and is then displayed using the DSPSPLF command. When OUTPUT(*) is specified and the user returns from the DSPSPLF command, the SPOOL file is deleted.

*: The resulting SPOOLed file is displayed on the user's screen using the DSPSPLF command. Upon exiting from DSPSPLF, the SPOOLed file created by the command is deleted using the DLTSPLF command.
*PRINT: The resulting SPOOLed file is created on the output queue specified on the OUTQ parameter and then returns control to the caller.

Output queue (OUTQ)

Specifies output queue where the report is SPOOLed. NOTE the output is deleted by the command after it is viewed when OUTPUT(*) is specified. To avoid it being deleted, the user must specify OUTPUT(*PRINT).

Single values

*JOB: The current job's OUTQ receives the Object Report.

Qualifier 1: Output queue

name: Specify the name of output queue to which the report is SPOOLed.

Qualifier 2: Library

*LIBL
*CURLIB
name

Lines per inch (LPI)

Specifies the line spacing setting on the printer, in lines per inch, used by the DSPOBJINF command for the QPRINT printer file. In English, this means the number of lines per inch that are printed to the SPOOLED file. A setting of 8 is the default, meaning 8 lines per inch are printed. Higher or lower values may be specified if desired.

This is an optional parameter.

8: The output from DSPOBJINF uses 8 lines per inch.
lpi value: Specify the number of lines per inch for the DSPOBJINF command. Valid choices include: 3 4 6 7.5 8 9 12 however 6, 8 and 12 are most common, while 7.5 is only valid for DBCS printers.

Characters per inch (CPI)

Specifies the printer character density (in characters per inch) used by the DSPOBJINF command.

This is an optional parameter.

13.3: The output from DSPOBJINF uses 13.3 characters per inch. This causes the output to use the full 11 inch wide page (landscape mode) and provide full coverage of 132 characters.
cpi value: Specify the number of character per inch for the DSPOBJINF command. Valid choices include: 5, 10, 12, 13.3, 15, 16.7, 18, and 20.
Use 13.3 for 11-inch wide paper to get the full 132 columns. Using a CPF(12) setting, while mathematically within 132/11 will not produce the desired results as paper margins need to be considered.

Overflow Line Number (OVRFLW)

Specifies the line number on the page at which overflow to a new page occurs. Generally, after the specified line is printed, the printer overflows to the next page before printing continues. Overflow is signaled when the specified line number is made the current line, whether printing has occurred on that line or not. The value specified must not exceed the forms length.

This is an optional parameter.

*HALFINCH or .5: The overflow line number is calculated and set to 1/2 inch before the bottom of the page. The Line per inch (LPI) and Lines per page (LPP) are used to calculate the Overflow line number.
1-255: Specify the line number on the page at which point the overflow indicator is set on, whether or not printing has occurred on that line. The value specified must not be greater than the page length. Margins specified for the printer file are ignored when determining overflow.

Examples for DSPOBJINF

Example 1: Simple Command Example

DSPOBJINF  KWD1(PARMVAL1)

This command <...>

Example 2: More Complex Command Example

DSPOBJINF   KWD1(PARMVAL1)  KWD2(PARMVAL2)
            KWD3(PARMVAL3)

This command <...>

Error messages for DSPOBJINF

*ESCAPE Messages

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.
CPF9820: Not authorized to use library &1.
CPF9830: Cannot assign library &1.
CPF9899: Error occurred during processing of command.