RTVUSRSPC       RETRIEVE USER SPACE                    TAASPCJ

 The Retrieve User Space  command allows the retrieval of  5000 or 32000
 bytes from  a User Space.   A start  position may be  specified so that
 multiple  commands may be used  to retrieve the data  from a large user
 space.

 A typical command would be:

              DCL           &VALUE *CHAR LEN(5000)
               .
              RTVUSRSPC     USRSPC(xxx) RTNVALUE(&VALUE)

 To retrieve 32,000 bytes, a typical command would be:

              DCL           &VALUE2 *CHAR LEN(32000)
               .
              RTVUSRSPC     USRSPC(xxx) RTNVALUE(&VALUE2)

 RTVUSRSPC command parameters                          *CMD
 ----------------------------

    USRSPC        The qualified  name  of  the User  Space  to  retrieve
                  from.   The library value defaults to  *LIBL.  *CURLIB
                  may also be used.

    RTNVALUE      The  return   value.    This  is  an  optional  return
                  parameter and  if  used  must be  specified  as  *CHAR
                  LEN(5000).   If less  than 5000  positions exist,  the
                  remaining positions will be blank.

    RTNVALUE2     The  return  value   as  32000  bytes.    This  is  an
                  optional  return  parameter  and   if  used  must   be
                  specified as  *CHAR LEN(32000).   If  less than  32000
                  positions  exist,  the  remaining  positions  will  be
                  blank.

    STRPOS        The  start  position  within  the  User  Space.    The
                  default is 1.

    RTNLEN        An optional return value  for the length of  the value
                  returned.   If specified, it must be  declared as *DEC
                  LEN(5 0).

                  The  value will normally  be 5000 and  is intended for
                  use with the  RTNVALUE parameter.   If there are  less
                  than 5000  bytes from  the start  position to the  end
                  of  the user space,  the value  will be the  number of
                  bytes remaining.

    RTNLEN2       An optional return value for  the length of the  value
                  returned.  If  specified, it must be declared  as *DEC
                  LEN(5 0).

                  The value  will normally be 32000 and  is intended for
                  use  with the RTNVALUE2 parameter.   If there are less
                  than 32000 bytes  from the start  position to the  end
                  of the  user space,  the value will  be the  number of
                  bytes remaining.


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

 None.

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

 The following TAA Tools must be on your system:

      CHKOBJ3         Check object 3
      EDTVAR          Edit variable
      RTVUSRSPCA      Retrieve user space attributes
      SNDESCMSG       Send escape message

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

 None, the tool is ready to use.

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

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

    RTVUSRSPC     *CMD                   TAASPCJ       QATTCMD
    TAASPCJC      *PGM       CLP         TAASPCJC      QATTCL

Added to TAA Productivity Tools May 1, 1998


Home Page

Last modified on March 10, 2014 © 1995, 2014 - TAA Tools, Inc.