TAA Tools
RTVFLROBJ       RETRIEVE FOLDER OBJECT                 TAADOCC

The   Retrieve  Folder   Object  command   allows   the  retrieval   of
information about  a *FLR object when only the  system object name that
exists  in the  QDOC library  is known.   The  system object  names may
appear from a function such  as when using the DSPOBJD outfile.   These
names do  not relate to a  user recognizable name.   RTVFLROBJ provides
a  translation from the  *FLR object name to  the information displayed
by WRKFLR.

A typical series of commands would be:

             DCLF       QADSPOBJ /* DSPOBJD model file */
             DCL        &DOCID *CHAR LEN(24)
             DCL        &FLRNAM *CHAR LEN(12)
              .
             DSPOBJD    OBJ(QDOC/*ALL) OBJTYPE(*FLR) +
                          OUTFILE(...)
              .
             RCVF
              .
             RTVFLROBJ  FLR(&ODOBNM) DOCID(&DOCID) FLRNAM(&FLRNAM)

RTVFLROBJ escape messages you can monitor for
---------------------------------------------

      TAA9891    Unable to find the folder

Escape messages from based on functions will be re-sent.

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

   FLR           The qualified  name of  the folder  as displayed  with
                 DSPOBJD.  The library qualifier defaults to QDOC.

   DOCID         The  document  ID.     This  is  an   optional  return
                 variable  that  if  used must  be  specified  as *CHAR
                 LEN(24).

   FLRNAM        The  folder  name.     This  is  an  optional   return
                 variable  that if  used  must  be specified  as  *CHAR
                 LEN(12).

   OWNER         The owner  of the object.  This  is an optional return
                 variable  that  if  used must  be  specified  as *CHAR
                 LEN(10).

   SIZE          The size of  the object.   This is an optional  return
                 variable  that  if  used  must be  specified  as  *DEC
                 LEN(15 0).

   INFLR         The  folder where  the folder  exists.  If  the folder
                 is not within  a folder, *NONE is  returned.  This  is
                 an  optional return  variable  that  if used  must  be
                 specified as *CHAR LEN(63).

   ASP           The  ASP  where   the  folder  exists.    This  is  an
                 optional  return  variable  that   if  used  must   be
                 specified as *DEC LEN(2 0).

   ASPOVRFLW     Whether  the   ASP   where  the   folder  exists   has
                 overflowed.   A  '0' is  returned if  the ASP  has not
                 overflowed  and '1'  if it has.   This  is an optional
                 return variable  that  if used  must be  specified  as
                 *CHAR LEN(1).


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

Because RTVFLROBJ returns  variables, it may only be used  in a CL type
of program.

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

The following TAA Tools must be on your system:

     RSNLSTMSG       Resend last message
     SNDESCINF       Send escape information
     SNDESCMSG       Send escape message

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

None, the tool is ready to use.

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

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

   RTVFLROBJ     *CMD                   TAADOCC       QATTCMD
   TAADOCCC      *PGM       CLP         TAADOCCC      QATTCL
					

Added to TAA Productivity tools July 15, 2013


Home Page Up to Top