TAA Tools
RTVMBRD3        RETRIEVE MEMBER DESCRIPTION 3          TAADBKU

The Retrieve  Member Description  3 tool  is designed  for HLL  program
use to  retrieve the description of a member.   An externally described
data  structure is used to both pass  the ID fields (file, library, and
member) and return the  description fields.  The program  TAADBKUR must
be  called and  passed the  externally  described data  structure.   No
command exists.

The  fields in  the Externally Described  Data Structure  match what is
available on  RTVMBRD.  You  may review  the fields  in the  Externally
Described Data Structure with the command:

             DSPFMT        FILE(TAADBKUP)

The system QUSRMBRD API is used to retrieve the information.

RPG III Code
------------

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(RTVMBRD3) to copy the  source from this documentation  member
to QATTINFO in TAATOOL.

     I* RTVMBRD3 externally described DS and program
     IMBRDS     E DSTAADBKUP
     I              'TAATOOL/TAADBKUR'    C         RTVMBR
     .
     C* Move fields and call RTVMBRD3 tool.
     C*   The MRFILE field must be a name
     C*   The MRLIB field may be a name, *CURLIB, or *LIBL
     C*       The return value will be the actual library
     C*   The MRMBR field may be a name, *FIRST, or *LAST
     C*       The return value will be the actual library
     C                     MOVELxxx       MRFILE    P      File name
     C                     MOVELxxx       MRLIB     P      Library name
     C                     MOVELxxx       MBMBR     P      Member name
     C                     CALL RTVMBR
     C                     PARM           MBRDS
     C* Fields such as MRTEXT, MRNRCD, etc are now avail to use

RPG IV Code
-----------

     D* RTVMBRD3 externally described DS and program
     D MBRDS         E DS                  EXTNAME(TAADBKUP)
     D RTVMBR          C                   CONST('TAATOOL/TAADBKUR')
     .
     C* Move fields and call RTVMBRD3 tool.
     C*   The MRFILE field must be a name
     C*   The MRLIB field may be a name, *CURLIB, or *LIBL
     C*       The return value will be the actual library
     C*   The MRMBR field may be a name, *FIRST, or *LAST
     C*       The return value will be the actual library
     C                   MOVEL(P)  ABC           MRFILE
     C                   MOVEL(P)  DEF           MRLIB
     C                   MOVEL(P)  GHI           MBMBR
     C                   CALL      RTVMBR
     C                   PARM                    MBRDS
     C* Fields such as MRTEXT, MRNRCD, etc are now avail to use

Reserved area in TAADBKUP
-------------------------

The TAADBKUP  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.

RTVMBRD3 escape messages you can monitor for
--------------------------------------------

      CPF9810    The library does not exist
      CPF9812    The file does not exist
      CPF9815    The member does not exist

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

No command exists.

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

None.

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

None.

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

None, the tool is ready to use.

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

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

   TAADBKUR      *PGM       RPGLE       TAADBKUR      QATTRPG
   TAADBKUP      *FILE      PF          TAADBKUP      QATTDDS
					

Added to TAA Productivity tools June 1, 2005


Home Page Up to Top