TAA Tools
RTVCTLLWS       RETRIEVE CONTROLLER DESCRP LOCAL WS    TAACFGI

The   Retrieve  Controller   Description   Local  Workstation   command
retrieves  information  about a  local  workstation  controller.   This
provides  the current information  about the controller.   The QDCRCTLD
API is used to retrieve the data.

A typical command would be:

             DCL        &NBRDEV *DEC LEN(5 0)
              .
             RTVCTLLWS  CTLD(CTL01) NBRDEV(&NBRDEV)

RTVCTLLWS escape messages you can monitor for
---------------------------------------------

      TAA9891    The controller is not a *LWS type.

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

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

   CTLD          The local workstation controller name.

   TYPE          The type of  controller.  This  is an optional  return
                 variable  that  if used  must  be  specified as  *CHAR
                 LEN(4).

   MODEL         The  model of controller.  This  is an optional return
                 variable that  if  used  must be  specified  as  *CHAR
                 LEN(4).

   RSRCNAME      The resource  name used  by the  controller.   This is
                 an  optional  return  variable that  if  used  must be
                 specified as *CHAR LEN(10).

   ONLINE        The type of  online request for  IPL.  A  *YES or  *NO
                 will  be  returned.    This   is  an  optional  return
                 variable  that  if used  must  be  specified as  *CHAR
                 LEN(4).

   AUTOCFG       Whether     the    controller     was    created    by
                 auto-configuration.  A  *YES or *NO will  be returned.
                 This  is  an optional  return  variable  that if  used
                 must be specified as *CHAR LEN(4).

   DFTWAIT       The  default wait  timeout value  set for  the devices
                 attached to  the  controller.   This  is  an  optional
                 return  variable that  if used  must  be specified  as
                 *DEC LEN(5 0).

   TDLC          The name  of the line associated  with the controller.
                 This is  an  optional  return variable  that  if  used
                 must be specified as *CHAR LEN(10).

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

   INZSRCL       The   name  of  the  source   file  library  used  for
                 initialization.  This  is an optional return  variable
                 that if used must be specified as *CHAR LEN(10).

   INZSRCM       The  name   of  the   source  file  member   used  for
                 initialization.   This is  an optional return variable
                 that if used must be specified as *CHAR LEN(10).

   INZPGM        The name  of  the  program  used  for  initialization.
                 This  is an  optional  return  variable that  if  used
                 must be specified as *CHAR LEN(10).

   INZPGMLIB     The   name   of   the   program   library   used   for
                 initialization.  This is  an optional return  variable
                 that if used must be specified as *CHAR LEN(10).

   MSGQ          The name  of the  message queue  used for  operational
                 messages.   This is  an optional return  variable that
                 if used must be specified as *CHAR LEN(10).

   MSGQLIB       The  name  of  the  message  queue  library  used  for
                 operational  messages.   This  is an  optional  return
                 variable  that  if used  must  be  specified as  *CHAR
                 LEN(10).

   CURMSGQ       The  name  of  the  current  message  queue  used  for
                 operational messages.    This is  an  optional  return
                 variable  that if  used  must  be specified  as  *CHAR
                 LEN(10).

   CURMSGQLIB    The  name of  the current  message queue  library used
                 for  operational  messages.    This  is  an   optional
                 return  variable that  if used  must  be specified  as
                 *CHAR LEN(10).

   SYSJOB        The  name  of  the  system  job  associated  with  the
                 controller.    This  is  an  optional  return variable
                 that if used must be specified as *CHAR LEN(10).

   NBRDEV        The number  of  devices  attached to  the  controller.
                 This  is  an optional  return  variable  that if  used
                 must be specified as *DEC LEN(5 0).

   DEVICES       A  list of the devices attached  to the controller.  A
                 maximum of 300  devices exists  with each device  name
                 10 bytes  in length.   The  remainder of  the area  is
                 filled  with  blanks.    This  is  an optional  return
                 variable that  if  used  must be  specified  as  *CHAR
                 LEN(3000).

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


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

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

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

The following TAA Tools must be on your system:

     SNDESCINF       Send escape information
     SNDESCMSG       Send escape message

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

None, the tool is ready to use.

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

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

   RTVCTLLWS     *CMD                   TAACFGI       QATTCMD
   TAACFGIC      *PGM       CLP         TAACFGIC      QATTCL
					

Added to TAA Productivity tools September 15, 2007


Home Page Up to Top