Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Source Information |  Call Graph |  External References |  All
Print Page as PDF
Remote Procedure: ROR LIST STATES

Package: Clinical Case Registries

Remote Procedure: ROR LIST STATES


Source Information

Name Value
NAME ROR LIST STATES
TAG STATELST
ROUTINE RORRP029
RETURN VALUE TYPE GLOBAL ARRAY
AVAILABILITY RESTRICTED
WORD WRAP ON TRUE
VERSION 1
DESCRIPTION
The ROR LIST STATES remote procedure returns a list of states that conform
the search criteria.
INPUT PARAMETER
  1. INPUT PARAMETER:   PART
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The PART parameter defines the search pattern. If it contains 2 character
    abbreviation of the state and the FLAGS parameter contains "A" then the
    corresponding state is returned (see the FLAGS parameter for more
    details). Otherwise, the regular search among state names is performed.
    
  2. INPUT PARAMETER:   FLAGS
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    Flags that control the execution (can be combined):
         direction of normal traversal.
      A  Enable abbreviation search. If PART contains 2
         character abbreviation, the corresponding state
         is returned. If the length of PART parameter is
         not equal 2 or it does not contain a valid state
         abbreviation then the regular search is performed.
      B  Backwards. Traverses the index in the opposite
    
  3. INPUT PARAMETER:   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.
    
  4. INPUT PARAMETER:   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 states and the value of the FROM parameter for the 
next procedure call are returned in the Results[0] and the subsequent 
nodes of the global array contain the states.
  Results[0]            Result Descriptor
an error occurred during the execution of the remote procedure. In this 
                          ^01: Number of states
                          ^02: Values that comprise the FROM
                          ^nn: parameter for the subsequent call
  Results[i]            State
                          ^01: IEN
                          ^02: Name
                          ^03: Abbreviation
                          ^04: VA State Code
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

Call Graph

Call Graph

Call Graph Total: 1

Package Total Call Graph
Clinical Case Registries 1 STATELST^RORRP029  

External References

Name Field # of Occurrence
STATELST^RORRP029 1
Source Information |  Call Graph |  External References |  All