The Retrieve Object Description 4 command allows you to retrieve the
basic information about the first or only object of a specific name.
The library and object type default to *ALL. A total number of
objects that match the name is returned. If more than one object has
the same name, messages are sent describing the first 30.
To perform a 'check only', use TAA CHKOBJALL. To display a list of
the objects, use TAA DSPOBJD2. To retrieve a list, use TAA
RTVOBJLST. To create an outfile, use DSPOBJD or TAA CVTOBJDx.
A typical series of commands would be:
DCL &RTNLIB *CHAR LEN(10)
DCL &RTNTYPE *CHAR LEN(7)
DCL &RTNATTR *CHAR LEN(10)
DCL &RTNTEXT *CHAR LEN(50)
DCL &NBROBJ *DEC LEN(5 0)
.
RTVOBJD4 OBJ(xxx) RTNLIB(&RTNLIB) RTNTYPE(&RTNTYPE) +
RTNATTR(&RTNATTR) RTNTEXT(&RTNTEXT) +
NBROBJ(&NBROBJ)
The library qualifier and the object type default to *ALL.
If a single object exists, you would have retrieved the basic
information and no messages would occur. The &NBROBJ value would be
1.
If multiple objects exist, the &NBROBJ value would contain the count
and up to 30 messages would be sent describing those found. The
return values would exist for the first object found.
If the object does not exist, TAA9893 is sent as an escape message.
RTVOBJD4 escape messages you can monitor for
--------------------------------------------
TAA9893 No objects exist for the name
Escape messages from based on functions will be re-sent.
RTVOBJD4 Command parameters *CMD
---------------------------
OBJ The qualified name of the object. The object name
may be generic.
The default library qualifier is *ALL for all
libraries. A specific library, *LIBL, or *CURLIB
may also be used. A generic library name is also
supported.
OBJTYPE The object type. The default is *ALL for all object
types. A specific object type may be named. Use
the command prompter to see the supported values.
RTNLIB The library where the first object was found. This
is an optional return parameter that if used must be
declared as *CHAR LEN(10).
RTNTYPE The object type of the first object found. This is
an optional return parameter that if used must be
declared as *CHAR LEN(7).
RTNATTR The object attribute of the first object found.
This is an optional return parameter that if used
must be declared as *CHAR LEN(10).
RTNTEXT The object text of the first object found. This is
an optional return parameter that if used must be
declared as *CHAR LEN(50).
NBROBJ The number of objects that match the object name,
library qualifier, and type. This is an optional
return parameter that if used must be declared as
*DEC LEN(5 0).
Restrictions
------------
Because RTVOBJD4 returns values, the command may only be used in a CL
program.
Prerequisites
-------------
The following TAA Tools must be on your system:
RSNLSTMSG Resend last message
RTVOBJLST Retrieve object list
SNDESCINF Send escape information
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
RTVOBJD4 *CMD TAAOBMG QATTCMD
TAAOBMGC *PGM CLP TAAOBMGC QATTCL
|
