TAA Tools
RTVOBJJRNA      RETRIEVE OBJECT JOURNAL ATTRIBUTES     TAAOBKP

The Retrieve  Object Journal  Attributes command retrieves  information
about  an object  that is being  journaled.   Only *FILE,  *DTAARA, and
*DTAQ  objects  may be  specified.   The information  returned includes
whether the object is  journaled, the journal name, images  value, etc.

If the object  is not journaled, only the  STATUS and RTNLIB parameters
will be returned.  The other values will be blank.

The QUSROBJD API is used with format OBJD0400.

A typical series of commands would be:

             DCL           &STATUS *CHAR LEN(4)
              .
             RTVOBJJRNA    OBJ(xxx) STATUS(&STATUS)
             IF            (&STATUS *EQ '*YES') DO /* Being jrnled */

*DTAARA  and  *DTAQ objects  only return  the  information that  may be
specified for the object when journaling is started.

RTVOBJJRNA escape messages you can monitor for
----------------------------------------------

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

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

   OBJ           The qualified name of the  object.  The library  value
                 defaults to *LIBL.  *CURLIB may also be used.

   OBJTYPE       The object  type to be retrieved.   The value  must be
                 *FILE,  *DTAARA, or  *DTAQ.   Physical files  may have
                 their data  journaled.    Both  physical  and  logical
                 files may have their access paths journaled.

   RTNLIB        The library where  the object exists.  This  value may
                 be  helpful  if  a  special  value  is  used  for  the
                 qualified  library name of the  object.  If specified,
                 it must be declared as *CHAR LEN(10).

   STATUS        The status  of whether  the  object is  journaled.   A
                 *YES or *NO  will be returned.  If  specified, it must
                 be declared as *CHAR LEN(4).

   JRN           The  journal name  the object  is being  journaled to.
                 If specified, it  must be  declared as *CHAR  LEN(10).

   JRNLIB        The library  of the journal  that the object  is being
                 journaled  to.  If  specified, it must  be declared as
                 *CHAR LEN(10).

   IMAGES        The images value  that was specified  on the  STRJRNxx
                 command.   *AFTER or  *BOTH will  be returned.   If  a
                 file  is  not  being  journaled,  the  value  will  be
                 blank.    *DTAQ  objects do  not  support  images (the
                 value will  be  blank).    If specified,  it  must  be
                 declared as *CHAR LEN(7).

   OMTJRNE       Whether to  omit certain journal entries.   Only *FILE
                 objects  return  this  value which  will  be  *NONE or
                 *OPNCLO.   If  a  file  is not  being  journaled,  the
                 value will  be blank.   *DTAARA  and *DTAQ  objects do
                 not  have  the attribute  (the value  will  be blank).
                 If specified, it must be declared as *CHAR LEN(7).

   STRDATE       The  start   date   of   when   the   object   started
                 journaling.   The format  is CYYMMDD.   If  specified,
                 it must be declared as *CHAR LEN(7).

   STRTIME       The   start   time   of   when  the   object   started
                 journaling.   The format is  HHMMSS.  If specified, it
                 must be declared as *CHAR LEN(6).

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

Because the command  returns a variable,  it may only  be used in  a CL
program.

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

The following TAA Tools must be on your system:

     CHKOBJ3         Check object 3
     SNDESCMSG       Send escape message

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

None, the tool is ready to use.

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

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

   RTVOBJJRNA    *CMD                   TAAOBKP       QATTCMD
   TAAOBKPC      *PGM       CLP         TAAOBKPC      QATTCL
					

Added to TAA Productivity tools September 15, 2002


Home Page Up to Top