TAA Tools

 RTVIFSED        RETRIEVE IFS ENTRY DESCRIPTION         TAAIFSM

 The  Retrieve IFS  Entry  Description tool  provides  two commands  for
 retrieving  object  information  about an  IFS  object  (the number  of
 return  parameters  exceeds  the  limit for  a  single  command).   The
 information returned includes  the owner, size,  create date and  other
 data  that  can  be  seen  with  the  Display  Attributes  option  from
 DSP/WRKLNK.

 A typical command would be:

              DCL           &OWNER *CHAR LEN(10)
               .
              RTVIFSED      OBJ('/home/...') OWNER(&OWNER)

 The second command is RTVIFSED2.

 The major API used is Qp0lGetAttr.

 RTVIFSED escape messages you can monitor for
 --------------------------------------------

       CPFA0A9    Object not found
       CPF9898    General escape message

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

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

    OBJ           The  path name  of the  object to  be retrieved.   The
                  object path  name can  be either  a simple  name or  a
                  name  that   is  qualified   with  the  name   of  the
                  directory in which the object is located.

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

    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).

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

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

    USRTYPPRF     A  *YES/*NO return  value for whether  the owner  is a
                  user type  profile as  opposed  to a  system  supplied
                  user profile.   The determination  of this is  done by
                  the  TAA  RTVIBMPRF  command.    This is  an  optional
                  return  variable  that if  used  must be  specified as
                  *CHAR LEN(4).

    CRTDAT        The create  date  of  the object  in  CYYMMDD  format.
                  This  is  an optional  return  variable  that if  used
                  must be specified as *CHAR LEN(7).

    CRTTIM        The  create  time  of  the  object  in  HHMMSS format.
                  This is  an  optional  return variable  that  if  used
                  must be specified as *CHAR LEN(6).

    ATRCHGDAT     The  last  date  the  attributes of  the  object  were
                  changed  in  CYYMMDD  format.    This  is an  optional
                  return variable  that if  used  must be  specified  as
                  *CHAR LEN(7).

    ATRCHGTIM     The  last  time  the attributes  of  the  object  were
                  changed  in  HHMMSS  format.    This  is  an  optional
                  return  variable  that if  used  must be  specified as
                  *CHAR LEN(6).

    DTACHGDAT     The  last  date  that  the  data  in  the  object  was
                  changed  in  CYYMMDD  format.   This  is  an  optional
                  return  variable  that if  used must  be  specified as
                  *CHAR LEN(7).

    DTACHGTIM     The last time  the data in the  object was changed  in
                  HHMMSS format.   This is  an optional  return variable
                  that if used must be specified as *CHAR LEN(6).

    ACCDAT        The  last   date  that  the  object  was  accessed  in
                  CYYMMDD format.  This  is an optional return  variable
                  that if used must be specified as *CHAR LEN(7).

    ACCTIM        The  last  time  the object  was  accessed  in  HHMMSS
                  format.   This is an optional return  variable that if
                  used must be specified as *CHAR LEN(6).

    USEDAT        The  last  date that  the object  was used  in CYYMMDD
                  format.  This is  an optional return variable that  if
                  used must be specified as *CHAR LEN(7).

    USETIM        The last  time the object  was used in  HHMMSS format.
                  This  is  an  optional return  variable  that  if used
                  must be specified as *CHAR LEN(6).

    RESETDAT      The last date that object  'use date' and 'days  used'
                  were reset  in CYYMMDD  format.   This is  an optional
                  return  variable  that if  used must  be  specified as
                  *CHAR LEN(7).

    RESETTIM      The last time that object  'use date' and 'days  used'
                  were reset  in  HHMMSS format.   This  is an  optional
                  return  variable that  if  used must  be  specified as
                  *CHAR LEN(6).

    DAYSUSED      The  number  of days  that  the object  has  been used
                  since the the last  'reset date'.  This count  is only
                  updated once  per day used not  each use.  This  is an
                  optional   return  variable  that  if   used  must  be
                  specified as *DEC LEN(7 0).

    FREESTG       A Y/N value  for whether  the storage  has been  freed
                  of the  object.  This  is an optional  return variable
                  that if used must be specified as *CHAR LEN(1).

    LCLRMTOBJ     An  L  or  R  value  for  whether  the  object  exists
                  locally or  remotely.    This is  an  optional  return
                  variable  that if  used  must  be specified  as  *CHAR
                  LEN(1).

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

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

    ASP           The  Auxiliary Storage  Pool of  the object.   This is
                  an optional  return  variable  that if  used  must  be
                  specified as *DEC LEN(2 0).

                  If  the  ASP number  is  greater  than 99,  the  value
                  returned  will be -1 and  the actual value  will be in
                  the ASPL  return parameter.   If  the value  is 99  or
                  less, the ASP and ASPL values will be the same.

    PCRDONLY      A Y/N  return value  for whether  this is  a PC  'read
                  only'  object.   This is  an optional  return variable
                  that if used must be specified as *CHAR LEN(1).

    PCHIDDEN      A  Y/N return value for whether  this is a PC 'hidden'
                  object.  This is  an optional return variable  that if
                  used must be specified as *CHAR LEN(1).

    PCSYSOBJ      A Y/N  return value  for whether this  is a  PC system
                  object.   This is an optional  return variable that if
                  used must be specified as *CHAR LEN(1).

    PCNEEDARC     A Y/N return  value for  whether this is  a PC  object
                  that needs to  be archived.  A 'Y'  indicates that the
                  PC  object has  been changed  since  the last  time it
                  was saved  on the  PC.   This  is an  optional  return
                  variable  that if  used  must  be specified  as  *CHAR
                  LEN(1).

    STMFFMT       The type  of format used  for a *STMF.   Either *TYPE1
                  or  *TYPE2 will  be returned.   *TYPE1 is  used if the
                  stream file was created  prior to V4R4M0.  This  is an
                  optional  return   variable  that  if   used  must  be
                  specified as *CHAR LEN(10).

    UDFSFTFMT     The  default  format used  for  a  UDFS.   This  is an
                  optional  return  variable  that   if  used  must   be
                  specified as *CHAR LEN(10).

    STMFALLWRT    A Y/N return  value for whether a  *STMF object should
                  allow  a write during  a save  operation.  This  is an
                  optional  return  variable  that   if  used  must   be
                  specified as *CHAR LEN(10).

    DIGITSIGN     A  Y/N  return   value  for  whether  the   object  is
                  'digitally  signed.'   This  is  an   optional  return
                  variable  that  if  used must  be  specified  as *CHAR
                  LEN(1).

    CHKOUTUSR     The  user  name who  has  'checked  out'  the  object.
                  This  is  an optional  return  variable  that if  used
                  must be specified as *CHAR LEN(10).

    CHKOUTDAT     The  last date  that the  object was 'checked  out' in
                  CYYMMDD format.  This  is an optional return  variable
                  that if used must be specified as *CHAR LEN(7).

    CHKOUTTIM     The last  time that  the object  was 'checked out'  in
                  HHMMSS  format.  This  is an  optional return variable
                  that if used must be specified as *CHAR LEN(6).

    USRPRF        The user profile that will  be switched to during  run
                  time.   QSECOFR  is  the default.    For file  systems
                  (such as  QNTC), CVTIFS will fail if  QSECOFR does not
                  exist.

                  *CURRENT  may be used or  a specific user profile, but
                  the profile must have *ALLOBJ special authority.

    ASPL          The Auxiliary  Storage Pool of  the object.   This  is
                  an  optional  return variable  that  if  used must  be
                  specified as *DEC LEN(3 0).

                  If  the  ASP  number is  greater  than  99,  the value
                  returned for  the ASP  parameter will  be  -1 and  the
                  actual value  will be  in the  ASPL return  parameter.
                  If  the value is 99  or less, the ASP  and ASPL values
                  will be the same.

 RTVIFSED 2 Command parameters                          *CMD
 -----------------------------

    OBJ           The path  name of  the object  to be  retrieved.   The
                  object path  name can  be either  a simple  name or  a
                  name   that  is  qualified   with  the  name   of  the
                  directory in which the object is located.

    CODEPAGE      The  Code Page  of the  object.   This is  an optional
                  return variable  that  if used  must  be specified  as
                  *DEC LEN(5 0).

    CCSID         The Coded  Character Set  of the object.   This  is an
                  optional   return  variable  that  if   used  must  be
                  specified as *DEC LEN(5 0).

    FILEID        The File ID of the  object.  This could be helpful  if
                  you are  going to  use an  API requiring the  internal
                  ID  of  the  object.    This  is  an  optional  return
                  variable that  if  used  must be  specified  as  *CHAR
                  LEN(16).

    OBJJRN        A  Y/N value  for  whether  the object  is  journaled.
                  This  is  an optional  return  variable  that if  used
                  must be specified as *CHAR LEN(1).

    JRNLID        The  journal ID assigned.   This is an optional return
                  variable that  if  used  must be  specified  as  *CHAR
                  LEN(10).

    JRN           The journal  the object is  journaled to.  This  is an
                  optional   return  variable  that   if  used  must  be
                  specified as *CHAR LEN(10).

    JRNLIB        The library  of the  journal the  object is  journaled
                  to.   This  is  an optional  return  variable that  if
                  used must be specified as *CHAR LEN(10).

    JRNSTRDAT     The  start date when the  object started journaling in
                  CYYMMDD format.  This  is an optional return  variable
                  that if used must be specified as *CHAR LEN(7).

    JRNSTRTIM     The start time  when the object started  journaling in
                  HHMMSS  format.  This  is an optional  return variable
                  that if used must be specified as *CHAR LEN(6).

    ASNEEDARC     A  Y/N  return  variable  that  describes  whether the
                  object has  been  changed and  needs  to be  archived.
                  This value  can be seen  with WRKLNK option 8  - 'Need
                  to  archive (System)'.  A  'Y' = Yes or  'N' = No will
                  be returned.   This  is  an optional  return  variable
                  that if used must be specified as *CHAR LEN(1).

    AUDITVAL      The audit  value of  the object.   The value  returned
                  will  be *NONE,  *USRPRF, *CHANGE, or  *ALL.   This is
                  an optional  return  variable  that if  used  must  be
                  specified as *CHAR LEN(10).

    SAVOBJ        A  Y/N value  for  whether the  object  can be  saved.
                  This  is  an optional  return  variable  that if  used
                  must be specified as *CHAR LEN(1).

    USRPRF        The  user profile that will  be switched to during run
                  time.   QSECOFR  is the  default.   For  file  systems
                  (such as  QNTC), CVTIFS will fail if  QSECOFR does not
                  exist.

                  *CURRENT  may be used or a  specific user profile, but
                  the profile must have *ALLOBJ special authority.

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

 None.

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

 The following TAA Tools must be on your system:

      SNDESCMSG       Send escape message
      RTVIBMPRF       Retrieve IBM Profile

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

 None, the tool is ready to use.

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

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

    RTVIFSED      *CMD                   TAAIFSM       QATTCMD
    RTVIFSED2     *CMD                   TAAIFSM2      QATTCMD
    TAAIFSMC      *PGM       CLP         TAAIFSMC      QATTCL
    TAAIFSMC2     *PGM       CLP         TAAIFSMC2     QATTCL
    TAAIFSMR      *PGM       RPGLE       TAAIFSMR      QATTRPG
    TAAIFSMR2     *PGM       RPGLE       TAAIFSMR2     QATTRPG

Added to TAA Productivity Tools October 15, 2001


Home Page

Last modified on November 19, 2014 © 1995, 2014 - TAA Tools, Inc.