ROR LIST VISTA USERS (1790)    REMOTE PROCEDURE (8994)

Name Value
NAME ROR LIST VISTA USERS
TAG USERLIST
ROUTINE RORRP024
RETURN VALUE TYPE GLOBAL ARRAY
AVAILABILITY RESTRICTED
WORD WRAP ON TRUE
VERSION 1
DESCRIPTION
The ROR LIST VISTA USERS remote procedure returns a list of users from the
NEW PERSON file (#200).
INPUT PARAMETER
  • PART
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The PART parameter defines the search pattern. It should contain the
    beginning of the user's name.
    
  • FLAGS
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    Flags that control the execution (can be combined):
     
      B  Backwards. Traverses the index in the opposite
         direction of normal traversal.
     
      D  Get default division for each user
     
      P  Select providers only (check for the PROVIDER
         security key).
    
  • NUMBER
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    Maximum number of entries to return. A value of "*" or no value in this 
    parameter designates all entries that conform the criteria.
    
  • FROM
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    The index entry(s) from which to begin the list. Use the pieces of the
    Results[0] (starting from the second one) to continue the listing in the
    subsequent procedure calls.
     
    NOTE: The FROM value itself is not included in the
          resulting list.
     
    See description of the LIST^DIC for more details about the PART, NUMBER
    and FROM parameters.
    
RETURN PARAMETER DESCRIPTION
A negative value of the first "^"-piece of the Results[0] indicates that 
  Results[i]            Error Descriptor
                          ^01: Error code
                          ^02: Message
                          ^03: Place of the error
 
Otherwise, number of VistA users and the value of the FROM parameter for
the next procedure call are returned in the Results[0] and the subsequent
nodes of the Results array contain the users.
  
  Results[0]            Result Descriptor
an error occurred during the execution of the remote procedure. In this 
                          ^01: Number of users
                          ^02: Values that comprise the FROM parameter
                          ^nn: for the subsequent call of the procedure
 
  Results[i]            VistA User
                          ^01: IEN (DUZ)
                          ^02: Name
                          ^03: Office Phone
                          ^04: Nickname
                          ^06: Default Division IEN  (only if D flag)
case, the second piece of the Results[0] will contain number of the error
                          ^07: Default Division Name (only if D flag)
descriptors returned in the subsequent nodes of the Results array:
  
  Results[0]            Result Descriptor
                          ^01: The last error code
                          ^02: Number of the error descriptors