ROR LIST PARAMETER INSTANCES (2108)    REMOTE PROCEDURE (8994)

Name Value
NAME ROR LIST PARAMETER INSTANCES
TAG GETPLIST
ROUTINE RORRP038
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
WORD WRAP ON TRUE
INPUT PARAMETER
  • NAME
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   60
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The NAME parameter defines the name of the parameter.
    
  • ENTITY
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    The ENTITY parameter defines the area(s) where the parameter value is
    searched for. By default ($G(ENTITY)=""), the "ALL" value is used (see the
    DBIA #2263 for more details). The other values that are used most often
    are the "USR" (user settings) and the "PKG" (package settings).
    
  • PREFIX
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    Only those instances are selected whose names begin from a value of this 
    parameter.  By default ($G(PREFIX)=""), all instances are selected.
    
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, the Results[0] contains number of parameter instances and the
subsequent node(s) of the Results array contain the instance names and
values:
 
  Results[0]            Number of instances
an error occurred during the execution of the remote procedure. In this
 
  Results[i]            Instance name^Internal value
case, the second piece of the Results[0] will contain number of the error
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