TAA Tools
RTVMNUA         RETRIEVE MENU ATTRIBUTES               TAAMNUC

The Retrieve  Menu  Attributes command  retrieves the  attributes of  a
*MENU  object.   This  assists in  any application  function  where the
attributes  of a  menu are needed.   The function  is release dependent
and limited to  upper and  lower case English  versions of the  listing
output.

No API  exists for this type of  retrieve so DSPMNUA is  used to create
a spooled file which is then read to retrieve the attributes.

A typical series of commands would be:

             DCL           &PGM *CHAR LEN(10)
              .
             RTVMNUA       MENU(xxx) PGM(&PGM)

The &PGM variable is only filled if a *PGM type of menu exists.

DSPMNUA escape messages you can monitor for
-------------------------------------------

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

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

   MENU          The   qualified   name  of   the   menu   to  retrieve
                 attributes  for.    The  library  value  defaults   to
                 *LIBL.  *CURLIB may also be used.

   TYPE          The  type of  menu.   The  possible  values are  *PGM,
                 *UIM, or  *DSPF.  This is  an optional return variable
                 that if used must be specified as *CHAR LEN(10).

   PGM           The program  used by  the  menu.   The value  is  only
                 returned for TYPE(*PGM).   This is an  optional return
                 variable  that  if used  must  be  specified as  *CHAR
                 LEN(10).

   PGMLIB        The  program library used  by the menu.   The value is
                 only returned  for TYPE(*PGM).   This  is an  optional
                 return  variable that  if  used must  be specified  as
                 *CHAR LEN(10).

   DSPF          The  display  file used  by the  menu.   The  value is
                 only returned for  TYPE(*DSPF).   This is an  optional
                 return  variable that  if used  must  be specified  as
                 *CHAR LEN(10).

   DSPFLIB       The  display  file  library used  by  the  menu.   The
                 value is only  returned for TYPE(*DSPF).   This is  an
                 optional  return  variable   that  if  used   must  be
                 specified as *CHAR LEN(10).

   MSGF          The  message file  used  by the  menu.   The  value is
                 only  returned for  TYPE(*DSPF).  This  is an optional
                 return variable  that  if used  must be  specified  as
                 *CHAR LEN(10).

   MSGFLIB       The  message  file library  used  by  the  menu.   The
                 value  is only returned  for TYPE(*DSPF).   This is an
                 optional  return  variable  that   if  used  must   be
                 specified as *CHAR LEN(10).

   CMDLIN        The command  line type  used by the  menu.   The value
                 is  only  returned  for  TYPE(*DSPF).    The  possible
                 values are  *LONG,  *SHORT,  or *NONE.    This  is  an
                 optional  return  variable   that  if  used   must  be
                 specified as *CHAR LEN(10).

   DSPKEY        The  display function  key  option used  by  the menu.
                 The  value  is  only returned  for  TYPE(*DSPF).   The
                 possible  values  are  *YES  or  *NO.     This  is  an
                 optional  return   variable  that  if   used  must  be
                 specified as *CHAR LEN(4).

   CURLIB        The  current library  used by  the menu.   This  is an
                 optional  return  variable  that   if  used  must   be
                 specified as *CHAR LEN(10).

   PRDLIB        The product  library used  by the  menu.   This is  an
                 optional   return  variable  that  if   used  must  be
                 specified as *CHAR LEN(10).

   TEXT          The  text  description  of  the  menu.    This  is  an
                 optional  return  variable   that  if  used   must  be
                 specified as *CHAR LEN(50).

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

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

Because  a spooled file must  be read, the command  is limited to upper
and lower case English language versions.

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

   RTVMNUA       *CMD                   TAAMNUC       QATTCMD
   TAAMNUCC      *PGM       CLP         TAAMNUCC      QATTCL
					

Added to TAA Productivity tools July 15, 2003


Home Page Up to Top