TAA Tools
RTVOUTFILE      RETRIEVE OUTFILE                       TAADBKG

The Retrieve Outfile  command retrieves the  model file and  format for
commands  which create  outfiles.   Both system  DSPxxx and  TAA CVTxxx
commands  are supported.   RTVOUTFILE  may only  be used  with commands
that use  a  single outfile.    For example,  DSPFD and  CVTFD  support
multiple  outfiles and  are not  supported.   If a  TAA CVT  command is
used, the outfile name used is also retrieved if one exists.

A typical series of commands would be:

            DCL            &MODELFILE *CHAR LEN(10)
             .
            RTVOUTFILE     CMD(xxx) MODELFILE(&MODELFILE)

The  TAA  Tool  PRTOUTFILE is  used  to supply  the  information.   The
command must exist within PRTOUTFILE to be valid.

RTVOUTFILE escape messages you can monitor for
----------------------------------------------

      TAA9891    The command entered was not found in the
                   information provided by PRTOUTFILE

      TAA9892    The command has multiple outfiles and cannot
                   be used by RTVOUTFILE (Only commands with a
                   single outfile may be specified)

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

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

   CMD           The command name to  retrieve the outfile  information
                 for.  Either  a system command such as  DSPOBJD may be
                 entered or a TAA CVT command such as CVTOUTQ.

                 The  command name must  exist in the  data supplied by
                 the PRTOUTFILE TAA command.

                 Only commands that  have a single  outfile are  valid.
                 For example,  DSPFD supports  multiple formats and  is
                 not valid on RTVOUTFILE.

   TYPE          The type  of command returned.  Either  SYS for system
                 commands   or  TAA  for  TAA  Tool  commands  will  be
                 returned.   This is an  optional return variable  that
                 if used must be specified as *CHAR LEN(3).

   MODELFILE     The  name of  the model  file.   This  is an  optional
                 return  variable  that if  used must  be  specified as
                 *CHAR LEN(10).

   FORMAT        The format  name  in  the  model file.    This  is  an
                 optional  return   variable  that  if  used   must  be
                 specified as *CHAR LEN(10).

   TAANAME       The  TAA name used as  the outfile name.   If a system
                 command is  specified,  the  value  returned  will  be
                 blank.

                 TAA commands such  as CVTOUTQ have a  standard outfile
                 name  such as OUTQP.   This  name will be  returned if
                 it exists.

                 Some  TAA commands  such as CVTFRMOUTQ  allow the user
                 of  the command  to  name  the  outfile.   If  such  a
                 command  is  specified,  the   return  value  will  be
                 blank.

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

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

Only commands with a single outfile may be named.

Only commands described by the PRTOUTFILE TAA tool may be used.

See the previous comments about the TAANAME return value.

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

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

The following TAA Tools must be on your system:

     PRTOUTFILE      Print outfile
     SNDESCMSG       Send escape message

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

None, the tool is ready to use.

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

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

   RTVOUTFILE    *CMD                   TAADBKG       QATTCMD
   TAADBKGC      *PGM       CLP         TAADBKGC      QATTCL
   TAADBKGR      *PGM       RPG         TAADBKGR      QATTRPG
					

Added to TAA Productivity tools October 15, 2003


Home Page Up to Top