VBScript Reference Manual for InduSoft Web Studio

InduSoft Web Studio VBScript Reference Manual
Dictionary Object
The dictionary object is contained in the Scripting Type library and is a general-purpose data structure
that is a cross between a link list and an array. The dictionary stores data and makes the data
accessible from one variable. The advantages of a dictionary over an array are:
• You can use “keys” to identify items in the dictionary. Keys are usually strings or integers but
can be any data type other than an array or a dictionary. Keys must be unique.
• Methods are provided to add new items and check for existing items in the dictionary
• The dictionary size can be changed without calling the ReDim statement
• Automatically “shifts up” the remaining items when any item in the dictionary is deleted
You can use a Dictionary when you need to access random elements frequently or need to access
information contained in the array based on its value, not position.
Dictionary
Description Is an associative array that can store any type of data. Data is accessed by a key.
Remarks Keys must be unique.
Property CompareMode
Description: Sets and returns the comparison mode for comparing a string keys in a
Dictionary object.
Arguments: Compare
Optional. If provided, compare is a value representing the comparison mode.
Values are:
0 = Binary
1 = Text
2 = Database
Values >2 can be used to refer to comparisons using specific Locale IDs
(LCID)
Return: Comparison mode
Remarks: An error occurs if you try to change the comparison mode of a Dictionary object
that already has data
Use Object.CompareMode[ = compare]
Example: Dim d
Set d = CreateObject(“Scripting.Dictionary”)
d.CompareMode = vbTextCompare
d.Add “a”, “Chicago”
d.Add “b”, “New York”
d.Add “A” = “Austin” ‘ Method fails because “b” already exists
Property Count
Description: Returns the number of items pairs in a Dictionary object.
Usage: Object.Count
Arguments: None
Return: Integer value of the count of item pairs in a Dictionary object.
Remarks: Read Only.
Example: Dim d, item_count
Set d = CreateObject(“Scripting.Dictionary”)
d.Add “a”, “Chicago”
d.Add “b”, “New York”
item_count = d.Count ‘ Count the items in a Dictionary object
MsgBox item_count
InduSoft, Ltd. 213