ROR LIST STATES

TITLEVALUE
NAMEROR LIST STATES
DESCRIPTIONThe ROR LIST STATES remote procedure returns a list of states that conform
the search criteria.
TAGSTATELST
ROUTINERORRP029
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERPART
DESCRIPTIONThe 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.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH30
INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERFLAGS
DESCRIPTIONFlags that control the execution (can be combined):

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
direction of normal traversal.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER3
INPUT PARAMETERNUMBER
DESCRIPTIONMaximum number of entries to return. A value of "*" or no value in this
parameter designates all entries that conform the criteria.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER4
INPUT PARAMETERFROM
DESCRIPTIONThe 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.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
RETURN VALUE TYPEGLOBAL ARRAY
RETURN PARAMETER DESCRIPTIONA negative value of the first "^"-piece of the Results[0] indicates that
an error occurred during the execution of the remote procedure. In this
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

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
^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
AVAILABILITYRESTRICTED
INACTIVE
CLIENT MANAGER
WORD WRAP ONTRUE
VERSION1
SUPPRESS RDV USER SETUP
APP PROXY ALLOWED