TAA Tools
RTVPFJRNA       RETRIEVE PHYSICAL FILE JRN ATTR       TAAJRNI

The Retrieve  Physical File  Journal Attributes  command retrieves  the
journaling  information about  a file.   A typical  use of  the command
would be:

         DCL         &JRNSTS *CHAR LEN(1)
         DCL         &IMAGES *CHAR LEN(6)
          .
         RTVPFJRNA   FILE(xxx) JRNSTS(&JRNSTS) IMAGES(&IMAGES)
         IF          (&JRNSTS *EQ 'Y') DO ...

The   RTVPFJRNA   command  uses   the  API   QDBRTVFD  to   access  the
information.   This  is  much  faster  than the  general  purpose  tool
RTVPFA.

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

   FILE          The  qualified file name  of the  physical file  to be
                 retrieved.    The  library  value  defaults  to *LIBL.
                 *CURLIB may be specified.

   RTNLIB        An optional  return  variable that  will  contain  the
                 library  name where  the file  was found.   The  value
                 may  be  helpful if  the  file is  accessed  without a
                 specific library  name.   If specified,  the  variable
                 must be declared as *CHAR LEN(10).

   JRNSTS        An  optional return  variable  that will  contain  the
                 current status  of the file.   A Y is  returned if the
                 file  is  currently  being  journaled.    If  a  N  is
                 returned, the file  is not currently  being journaled.
                 Other return  variables will  reflect the  values that
                 were   being  used   the  last   time  the   file  was
                 journaled.    If  specified,  the  variable  must   be
                 declared as *CHAR LEN(1).

   JRN           An  optional return  variable  that  will contain  the
                 name  of the  journal that  is  currently used  or was
                 last  used.    If  specified,  the  variable  must  be
                 declared as  *CHAR  LEN(10).   If the  file was  never
                 journaled, the value will be blank.

   JRNLIB        An  optional  return variable  that  will contain  the
                 name  of  the library  where  the journal  is  that is
                 currently used or  was last used.   If specified,  the
                 variable must  be declared as  *CHAR LEN(10).   If the
                 file was never journaled, the value will be blank.

   IMAGES        An  optional  return variable  that  will  contain the
                 value of  the  Record Images  option  if the  file  is
                 currently  journaled  or  was  last  journaled.    The
                 values   *NONE  or  *BOTH   will  be   returned.    If
                 specified, the  variable  must be  declared  as  *CHAR
                 LEN(6).   If the file  was never journaled,  the value
                 will be blank.

   OMTJRNE       An  optional  return variable  that  will contain  the
                 value  of the Omit Journal  Entries option if the file
                 is  currently journaled  or  was  last journaled.    A
                 value  of *NONE  or  *OMTJRNE will  be  returned.   If
                 specified,  the  variable must  be  declared  as *CHAR
                 LEN(7).  If  the file was  never journaled, the  value
                 will be blank.

   JRNSTRDAT     An  optional return  variable  that  will contain  the
                 date  the  file  started  journaling  if  the file  is
                 currently journaled or was  last journaled.  The  date
                 will be  in  the format  CYYMMDD.   If specified,  the
                 variable  must be declared  as *CHAR  LEN(7).   If the
                 file was never journaled, the value will be blank.

   JRNSTRTIM     An  optional  return  variable that  will  contain the
                 time  the file  started  journaling  if  the  file  is
                 currently journaled  or was last journaled.   The time
                 will  be  in the  format  HHMMSS.   If  specified, the
                 variable must be  declared as  *CHAR LEN(6).   If  the
                 file was never journaled, the value will be blank.

   TYPE          An optional  return variable  that will  contain D  if
                 the file  is a data file or S if  the file is a source
                 file.   If specified,  the variable  must be  declared
                 as *CHAR LEN(1).

   ACCPTHJRN     An optional return  variable that will contain Y  or N
                 if the  access path is  journaled.  If  specified, the
                 variable must be declared as *CHAR LEN(1).

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

Because  return variables are used,  the command can only  be used in a
CL program.

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

The following TAA Tools must be on your system:

     CHKNAM          Check name
     CVTBYTBIT       Convert byte to bits
     SNDESCMSG       Send escape message

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

None, the tool is ready to use.

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

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

   TAAJRNI       *CMD                   TAAJRNI       QATTCMD
   TAAJRNIC      *PGM       CLP         TAAJRNIC      QATTCL
					

Added to TAA Productivity tools May 1, 1996


Home Page Up to Top