TAA Tools
RTVMSGFA        RETRIEVE MESSAGE FILE ATTRIBUTES       TAAMSIF

The Retrieve Message  File Attributes command  uses an API  to retrieve
the attributes of a Message File.

A typical command would be:

             DCL       &CCSID *DEC LEN(5 0)
              .
             RTVMSGFA  MSGF(xxx) CCSID(&CCSID)

The API used is QMHRMFAT.

The  API does not  support the  number of  messages in a  message file.
This  can  be  determined  by using  CVTMSGF  and  then  displaying the
number of records.

RTVMSGFA escape messages you can monitor for
--------------------------------------------

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

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

   MSGF          The qualified  name of  the message  file to  retrieve
                 from.   The library value defaults to  *LIBL.  *CURLIB
                 may also be used.

   RTNLIB        An  optional return  variable  for the  actual library
                 of the message file.   This value may be helpful if  a
                 special value  was used  for the library  qualifier of
                 the  message  file.    If  used,  the  value  must  be
                 specified as *CHAR LEN(10).

   STGSIZ        An optional return  variable for the  storage size  of
                 the message  file.   The object  size will be  larger.
                 If  used, the value  must be  specified as  *DEC LEN(9
                 0).

   INCSTGSIZ     An   optional  return   variable  for   the  increment
                 storage  size of  the  message  file.   If  used,  the
                 value must be specified as *DEC LEN(9 0).

   NBRINC        An optional  return variable  for the number  of times
                 the  message  file has  been  increased in  size.   If
                 used, the value  must be specified  as *DEC LEN(9  0).

   MAXINC        An  optional return  variable for  the maximum  number
                 of times a message file can be increased in size.

                 The  system  API  used does  not  return  a value  for
                 *NOMAX which  is a  valid entry  on CRTMSGF.    *NOMAX
                 will  be assumed  if  the  value returned  for  MAXINC
                 times  the 'Increment  Storage Size'  is  greater than
                 15,000,000.

                 If   used,  the  value  must  be  specified  as  *CHAR
                 LEN(6).

   CCSID         An optional  return variable for  Coded Character  Set
                 Identifier.

                 Two values  are associated  with US English:  1) 65535
                 means  that no  conversions are  to occur  when adding
                 or retrieving  message  descriptions  from  the  file.
                 2) 65534  means to use  the CCSID associated  with the
                 message  description   when  adding  or  retrieving  a
                 message description.

                 Any  other  CCSID  means  to  use  the  CCSID  of  the
                 message description.

                 If used,  the value  must be  specified as *DEC  LEN(5
                 0).

   OWNER         An  optional  return variable  for  the  owner of  the
                 message  file.  If  used, the value  must be specified
                 as *CHAR LEN(10).

   TEXT          An optional return  variable for the  text description
                 of  the message  file.   If  used, the  value must  be
                 specified as *CHAR LEN(10).

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

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

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

The following TAA Tools must be on your system:

     CHKOBJ3         Check object 3

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

None, the tool is ready to use.

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

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

   RTVMSGFA      *CMD                   TAAMSIF       QATTCMD
   TAAMSIFC      *PGM       CLP         TAAMSIFC      QATTCL
					

Added to TAA Productivity tools March 15, 2002


Home Page Up to Top