RTVOBJD2        RETRIEVE OBJECT DESCRIPTION 2          TAAOBJW

 The Retrieve  Object Description  2 tool  is designed  for HLL  program
 use  to  retrieve  the   description  of  an  object.    An  externally
 described  data structure is  used to both pass  the ID fields (object,
 library, and  object  type) and  return the  description  fields.   The
 program  TAAOBJWR must be  called and  passed the  externally described
 data structure.  No command exists.

 You  may review the  fields in the Externally  Described Data Structure
 with the command:

              DSPFMT        FILE(TAAOBJWP)

 The  system  QUSROBJD  API  is   used  by  TAAOBJWR  to  retrieve   the
 information.

 The following  code is in  a format to be  copied directly into  an RPG
 program  and  shows how  the  tool would  be  used.   First  use CPYTAA
 TAAARCMBR(RTVOBJD2) to copy  the source for  this documentation  member
 to QATTINFO in TAATOOL.

      I* OBJRCD is defined by the RTVOBJD2 TAA Tool
      IOBJRCD    E DSTAAOBJWP
      I              'TAATOOL/TAAOBJWR'    C         RTVOBJ
      .
      C* Move fields and call RTVOBJD2 tool.
      C                     MOVELxxx       ODLBNM           Lib name
      C                     MOVELxxx       ODOBNM           Obj name
      C                     MOVELxxx       ODOBTP           Obj type
      C                     CALL RTVOBJ
      C                     PARM           OBJRCD
      C* Fields such as ODOBAT, ODOBSZ, etc are now avail to use

 If the  library name is  blank, *LIBL is  used.  ODLBNM  is set  by the
 program to  be the library where  the object was found.   The value may
 have changed when the program returns.

 If  the object  does not  exist, CPF9898 is  sent as  an escape message
 with the message text as received by the TAAOBJWR program.

 Most of the  field names used  are the same  as in the  DSPOBJD outfile
 such as ODOBNM.   The date fields are returned in  YYMMDD format in the
 externally  described data  structure  which differs  from most  of the
 outfile date definitions  of MMDDYY.   The ODOBSZ  (object size  field)
 is defined as  *DEC LEN(15 0) to  account for large object  sizes.  For
 most  of  the other  field names,  the  attributes and  meaning  of the
 values are the same as in the DSPOBJD outfile.

 Note that  for ILE  programs, neither  DSPOBJD, RTVOBJD,  nor  RTVOBJD2
 will return information about the source used.

 The TAAOBJWP  externally described data  structure has a  reserved area
 to  allow for  a reasonable  amount of  growth  for new  fields without
 impacting  existing programs.   If additional fields  are added that do
 not exceed the size of the  reserved field area, there is no  reason to
 re-create an  existing program that uses the  externally described data
 structure unless the information from the new fields is needed.

 Command parameters                                    *CMD
 ------------------

 No command exists.

 Restrictions
 ------------

 None.

 Prerequisites
 -------------

 The following TAA Tools must be on your system:

      HLRMVMSG        HLL Remove message
      RPGSTSDS        RPG status DS
      SNDESCMSG       Send escape message

 Implementation
 --------------

 None, the tool is ready to use.

 Objects used by the tool
 ------------------------

    Object        Type    Attribute      Src member    Src file
    ------        ----    ---------      ----------    ----------

    TAAOBJWR      *PGM       RPG         TAAOBJWR      QATTRPG
    TAAOBJWP      *FILE      PF          TAAOBJWP      QATTDDS

Added to TAA Productivity Tools August 1, 1997


Home Page

Last modified on March 10, 2014 © 1995, 2014 - TAA Tools, Inc.