Retrieve Object Description (RTVOBJD) UDTF

Index

Schema IQUERY

RTVOBJD( library_name => '*LIBL', 
         object_name => 'object-name', 
         object_type => '*FILE' )

The Retrieve Object Description (RTVOBJD) User Defined Table Function returns one row with the specified Object's Description. The information returned is similar to the QUSROBJD API with format OBJD0400.

For ILE *PGM and *SRVPGM objects, additional information is returned using QCLRPGMI or QBNRSPGM respectively.

Parameters

LIBRARY_NAME

The library name of the object. If unspecified, *LIBL is used.

OBJECT_NAME

The name of the object whose description is to be returned. This is a required parameter.

OBJECT_TYPE

The object type of the object. If unspecified *FILE is used. The object type may be specified with or without the leading asterisk.

Examples

select objowner, objtext, crtdate 
FROM TABLE( iQuery.RTVOBJD( 'PRODDATA','ORDERS','*FILE')) od;
select objowner, objtext, crtdate 
FROM TABLE( iQuery.RTVOBJD( object_name => 'SALES' )) fd;

ResultSet Columns

Column
Data Type
Description
OBJNAME
VARCHAR(10)
The name of the object whose description is returned.
OBJLIB
VARCHAR(10) The library name of the object returned (as specified on the UDTF itself.
OBJTYPE
VARCHAR(10) The object type of the object.
RTNLIB
VARCHAR(10) The actual library where the object was found (for example if *LIBL was specified on the input)
SRCFILE
VARCHAR(10) The source file used to create the object. If more than one *MODULE is used to create the object (for *PGM or *SRVPGM objects) then the first one is returned.
SRCLIB
VARCHAR(10) The source file library used to create the object.
SRCMBR
VARCHAR(10) The source member name used to created the object.
OBJCRTDATE
timestamp
The object's creation timestamp.
CRTDATE
date
The object creation date.
CRTTIME
time
The object creation time.
OBJCHGDATE
timestamp
The last changed timestamp.
CHGDATE
date
The last changed date.
CHGTIME
time
The last changed time.
LASTUSEDDATE
date
The Last used date.
CCSID
int
The CCSID of the object.
OBJOWNER
VARCHAR(10) The User Profile of the Object Owner.
CREATOR
VARCHAR(10) The User Profile of the User who created the object.
RUNTIMEUSRPRF
VARCHAR(10) Either *USER or *OWNER for the runtime user.
RUNTIMEADOPT
VARCHAR(10) Returns *ADOPT for program objects that adopt the owners user profile when run.
ACTGRP
VARCHAR(10) The runtime activation group name for *PGM and *SRVPGM objects.
OBJDOMAIN
VARCHAR(8) The domain of the object. *USER or *SYSTEM
OBJATTR
VARCHAR(10) The extended object attributes, such as PF, RPGLE, DSPF, etc. for the object.
OBJTEXT
VARCHAR(50) The text description for the object.
MODULES
int
The number of *MODULE objects used to create the *PGM or *SRVPGM object. For other objects this is 0.
OBJSIZE
long int
The size of the object, in bytes.
DAMAGED
CHAR(1)
If retrieving the object description returns message CPF2115, then this field contains 'D' otherwise it is empty.
CHGSRCDATE
date
The last changed date of the source file used to create the object, at the time it was created.
CHGSRCTIME
time
The last changed time of the source file used to create the object, at the time it was created.
SAVED_DATE
date
The last date the object was saved.
SAVED_TIME
time
The last time the object was saved.
RESTORE_DATE
date
The last date the object was restored.
RESTORE_TIME
time
The last time the object was restored.
CRTSYSNAME
VARCHAR(8)
The system name on which the object was created.
CRTSYSLVL
VARCHAR(10) The IBM i version and release (VxxRyyMxx) when the object was created.
COMPILER
VARCHAR(16) Contains a text string of the command used to create the object and the TGTRLS level. For example, CRTPGM V07R03M00
CRTOBJLVL
VARCHAR(10) Object control level.
LICPGM
VARCHAR(16) The object's licensed program (if any) and its release level. For example: 2IQCOZI6V06R01M00
PTFLVL
VARCHAR(10) The PTF level of the object
APAR
VARCHAR(10) The APAR last applied to the object (if any)
ERRMSGID
VARCHAR(7) Normally this column should be blank. If it contains a valid CPF message ID it represents the error returned when the UDTF called one of the low-level interfaces.