UOA:OMQRTVOB
Retrieve Object (OMQRTVOB) - Help
Retrieve Object (OMQRTVOB)
The Retrieve Object Description API command allows you to retrieve the description of an object in the TD/OMS database. This command has to be activated in a program.
Object (OBJC)
Specify the object code from which the description has to be retrieved.
- object-code
- Enter a valid object code.
Library (OBJL)
Specify the name of the library in which the object which has to be retrieved is located.
- library-code
- Enter a valid library code.
Object type (OBJT)
Specify the object type of the object from which the description has to be retrieved.
- object-type
- Enter a valid object type.
Detail code (DTLC)
Specify the detail code of the object from which the description has to be retrieved. If a detail code is specified additional parameters are provided to contain detail descriptions.
- *NONE
- No detail code is involved.
- detail-code
- Enter the code of the connected detail.
IFS Object (IFSOBJ)
Specify the IFS-object from which the description has to be retrieved. This has to be a full pathname.
- IFS-object
- Enter a valid IFS object.
CL var for APPL
Specify the name of a variable used to retrieve the application code. This should be a 5-character variable in CL programs.
CL var for ENVC
Specify the name of a variable used to retrieve the environment code. This should be a 5-character variable in CL programs.
CL var for OBJA
Specify the name of a variable used to retrieve the code of the object attribute. This should be a 10-character variable in CL programs.
CL var for OBJD
Specify the name of a variable used to retrieve the description of the specified object. This should be a 50-character variable in CL programs.
CL var for SRCF
Specify the name of a variable used to retrieve the name of the related source file. This should be a 10-character variable in CL programs.
CL var for SRCL
Specify the name of a variable used to retrieve the name of the library in which the source is located. This should be a 10-character variable in CL programs.
CL var for SRCM
Specify the name of a variable used to retrieve the name of the source member. This should be a 10-character variable in CL programs.
CL var for SRCS
Specify the name of a variable used to retrieve the source status. This should be a 1-character variable in CL programs.
CL var for SRCX
Specify the name of a variable used to retrieve the source change date. This should be a 13-character variable in CL programs. The format of the change date is CYYMMDDHHMMSS (century, year, month, day, hour, minute, second).
CL var for OBJX
Specify the name of a variable used to retrieve the object source change date. This should be a 13-character variable in CL programs. The format of the change date is CYYMMDDHHMMSS (century, year, month, day, hour, minute, second).
CL var for OCRT
Specify the identification of the user who created this object in this environment. This should be a 10-character variable in CL programs.
CL var for FIX
Specify the code of the fix by which this object was placed in this environment. This should be a 10-character variable in CL programs.
CL var for USDF
Specify the name of a variable used to retrieve the user-defined attribute of the object. This should be a 1-character variable in CL programs.
CL var for TOVI
Specify the name of a variable used to retrieve the temporary or virtual object indicator. This should be a 1-character variable in CL programs.
CL var for OCLS
Specify the name of a variable used to retrieve the object class of the object. This should be a 1-character variable in CL programs.
CL var for VRSN
Specify the name of a variable used to retrieve the object's current version number. This should be a 5-position decimal variable in CL programs.
CL var for MODN
Specify the name of a variable used to retrieve the modification number of the object. This should be a 5-position decimal variable in CL programs.
CL var for CHGX
Specify the name of a variable used to retrieve the object change date. This should be a 13-character variable in CL programs. The format of the change date is CYYMMDDHHMMSS (century, year, month, day, hour, minute, second).
CL var for DTLA
Specify the name of a variable used to retrieve the attribute of the specified detail code. This should be a 10-character variable in CL programs.
CL var for DTLD
Specify the name of a variable used to retrieve the description of the specified detail code. This should be a 50-character variable in CL programs.
CL var for DTLFIX
Specify the code of the fix by which this detail was placed in this environment. This should be a 10-character variable in CL programs.
CL var for DTLUSDF
Specify the name of a variable used to retrieve the user-defined attribute of the detail. This should be a 1-character variable in CL programs.
CL var for DTLTOVI
Specify the name of a variable used to retrieve the temporary or virtual detail indicator. This should be a 1-character variable in CL programs.
CL var for FLR
Specify the name of a variable used to retrieve the name of the folder in which the object is located. This should be a 63-character variable in CL programs.
CL var for RTNOBJC
Specify the name of a variable used to retrieve the object code. For an IFS-object, the abbreviated name is returned. For other objects, the value specified in the OBJC parameter is returned. This should be a 12-character variable in CL programs.
CL var for RTNOBJL
Specify the name of a variable used to retrieve the object library. For an IFS-object, a handle to the directory name is returned. For other objects, the value specified in the OBJL parameter is returned. This should be a 10-character variable in CL programs.
CL var for RTNOBJT
Specify the name of a variable used to retrieve the object type. For an IFS-object, the object type (*STMF, *DIR ...) is returned. For other objects, the value specified in the OBJT parameter is returned. This should be a 9-character variable in CL programs.
CL var for RTNIFSOBJ
Specify the name of a variable used to retrieve the full pathname of the IFS-object. The name is capitalized according to the rules of the filesystem. This should be an 896-character variable in CL programs.
- Note
- For library-objects, the parameter returns the corresponding pathname for the object in the QSYS.LIB filesystem, as in the following example: For message file HELPMSG in library DEVLIB, the value
- /QSYS.LIB/DEVLIB.LIB/HELPMSG.MSGF will be returned.
CL var for VRS
DEPRECATED: USE VRSN.
CL var for MOD
DEPRECATED. USE MODN.