TAA Tools
RTVDIRE         Retrieve Directory Entry               TAADSTF

The Retrieve  Directory Entry command  retrieves a  system distribution
directory entry  (see WRKDIRE).  You must specify  the name and address
(the first two parts as shown on WRKDIRE).

A typical series of commands would be:

             DCL           &FULNAM *CHAR LEN(50)
             DCL           &DEPT *CHAR LEN(10)
              .
             RTVDIRE       USERID(USER1 USER1) FULNAM(&FULNAM) +
                             DEPT(&DEPT)

RTVDIRE escape messages you can monitor for
--------------------------------------------

      TAA9894    No entry was found

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

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

   USRID         A 2 part parameter that is required.

                 Part  1 is  the user  ID as  it appears in  the system
                 distribution directory (see WRKDIRE).

                 Part 2  is the  address as  it appears  in the  system
                 distribution directory and is also required.

   RTNDSC        The return address  which is the third part  of a full
                 address.   This  is an  optional return  variable that
                 if used must be specified as *CHAR LEN(50).

   SYSNAME       The name of  the system where the  user exists.   This
                 is an  optional return variable  that if used  must be
                 specified as *CHAR LEN(8).

   SYSGROUP      The name  of the system group the  user belongs.  This
                 is an optional  return variable that  if used must  be
                 specified as *CHAR LEN(8).

   NETUSRID      The network  user ID assigned  to the  user.  This  is
                 an  optional  return variable  that  if  used must  be
                 specified as *CHAR LEN(47).

   LSTNAM        The  last  name  of  the  user,  This  is  an optional
                 return variable  that  if used  must  be specified  as
                 *CHAR LEN(40).

   FSTNAM        The  first  name of  the  user,  This  is an  optional
                 return  variable  that if  used must  be  specified as
                 *CHAR LEN(20).

   MIDNAM        The middle  name  of the  user,  This is  an  optional
                 return  variable that  if used  must  be specified  as
                 *CHAR LEN(20).

   PREFNAM       The  preferred name  of the user  This is  an optional
                 return variable  that if  used  must be  specified  as
                 *CHAR LEN(20).

   FULNAM        The full name of  the user This is an  optional return
                 variable  that  if used  must  be  specified as  *CHAR
                 LEN(50).

   DEPT          The  department  the  user  works  in.    This  is  an
                 optional  return  variable   that  if  used  must   be
                 specified as *CHAR LEN(10).

   TITLE         The title  of the  user.  This  is an  optional return
                 variable  that  if  used must  be  specified  as *CHAR
                 LEN(40).

   CMPNY         The company the  user works in.   This is an  optional
                 return  variable that  if  used must  be specified  as
                 *CHAR LEN(50).

   TELNBR1       The  first telephone number of  the user.   This is an
                 optional  return  variable  that   if  used  must   be
                 specified as *CHAR LEN(26).

   TELNBR2       The second telephone number  of the user.  This  is an
                 optional  return   variable  that  if   used  must  be
                 specified as *CHAR LEN(26).

   FAXTELNBR     The  fax telephone  number of  the user.   This  is an
                 optional  return  variable   that  if  used   must  be
                 specified as *CHAR LEN(26).

   LOC           The location  of the user's business or  system.  This
                 is  an optional return  variable that if  used must be
                 specified as *CHAR LEN(40).

   BLDG          The building  where  the  user  works.    This  is  an
                 optional  return   variable  that  if  used   must  be
                 specified as *CHAR LEN(20).

   OFC           The  office  where   the  user  works.    This  is  an
                 optional  return  variable  that   if  used  must   be
                 specified as *CHAR LEN(16).

   ADDR1         The first  line of the  mailing address for  the user.
                 This  is  an optional  return  variable  that if  used
                 must be specified as *CHAR LEN(40).

   ADDR2         The  second line of the  mailing address for the user.
                 This is  an  optional  return variable  that  if  used
                 must be specified as *CHAR LEN(40).

   ADDR3         The third  line of the  mailing address for  the user.
                 This  is  an  optional return  variable  that  if used
                 must be specified as *CHAR LEN(40).

   ADDR4         The fourth line of the  mailing address for the  user.
                 This  is an  optional  return  variable that  if  used
                 must be specified as *CHAR LEN(40).

   INDUSR        A  *YES/*NO return  value for whether  the user  is an
                 indirect user.  See the  ADDDIRE command prompt for  a
                 full  description.     This  is  an   optional  return
                 variable  that  if used  must  be  specified as  *CHAR
                 LEN(4).

   PRTPERS       A  *YES/*NO  return  value for  whether  to  print the
                 user's private  mail for  an indirect user.   See  the
                 ADDDIRE command  prompt for a full  description.  This
                 is  an optional return  variable that if  used must be
                 specified as *CHAR LEN(4).

   PRTCOVER      A *YES/*NO  return  value  for whether  to  print  the
                 cover  page when  a mail  item  is printed.   See  the
                 ADDDIRE command  prompt for a full  description.  This
                 is an optional  return variable that  if used must  be
                 specified as *CHAR LEN(4).

   NFYMAIL       Whether the  user is notified  of mail  being received
                 by a  message sent to  the user's message  queue.  The
                 valid   return  values  are  *SPECIFIC,  *ALLMAIL,  or
                 *NOMAIL.  See  the ADDDIRE command  prompt for a  full
                 description.   This  is  an  optional return  variable
                 that if used must be specified as *CHAR LEN(9).

   NFYPTYPERS    A  *YES/*NO  return  value  for  whether  the  user is
                 notified of  priority,  private,  or  important  mail.
                 See   the   ADDDIRE   command  prompt   for   a   full
                 description.    This is  an  optional  return variable
                 that if used must be specified as *CHAR LEN(4).

   NFYMSGS       A *YES/*NO  return  value  for  whether  the  user  is
                 notified  of  messages  received.    See  the  ADDDIRE
                 command  prompt for a  full description.   This  is an
                 optional   return  variable  that   if  used  must  be
                 specified as *CHAR LEN(4).

   TEXT          The text description  of the entry.   See the  ADDDIRE
                 command  prompt for a  full description.   This  is an
                 optional   return  variable  that  if   used  must  be
                 specified as *CHAR LEN(50).

   ALWSYNC       A *YES/*NO  return value  for whether  synchronization
                 of  this  entry  with   other  directories  should  be
                 allowed.   See the  ADDDIRE command prompt  for a full
                 description.   This  is an  optional  return  variable
                 that if used must be specified as *CHAR LEN(4).

   DLOOWN        Whether  the  user  or  the   group  profile  will  be
                 assigned   to  the   ownership  of   Document  Library
                 objects.   The return values  are *USRPRF and *GRPPRF.
                 See   the  ADDDIRE   command   prompt   for   a   full
                 description.   This  is  an  optional return  variable
                 that if used must be specified as *CHAR LEN(7).

                 *NO  may be  specified to  add records to  an existing
                 file.


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

Because RTVDIRE returns values,  the command may only  be used in a  CL
type of program.

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

The following TAA Tools must be on your system:

     RMVMSGKEY       Remove message key
     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
   ------        ----    ---------      ----------    ----------

   RTVDIRE       *CMD                   TAADSTF       QATTCMD
   TAADSTFC      *PGM       CLP         TAADSTFC      QATTCL
					

Added to TAA Productivity tools March 26, 2007


Home Page Up to Top