CompareMode Property

Visual Basic Scripting

Microsoft® Visual Basic® Scripting Edition CompareMode Property  Scripting Run-Time Reference 
Version 2 

See Also                   Applies to


Description
Sets and returns the comparison mode for comparing string keys in a Dictionary object.
Syntax
object.CompareMode[ = compare]

The CompareMode property has the following parts:

Part Description
object Required. Always the name of a Dictionary object.
compare Optional. If provided, compare is a value representing the comparison mode used by functions such as StrComp.

Settings
The compare argument has the following settings:

Constant Value Description
vbBinaryCompare 0 Perform a binary comparison. vbTextCompare 1 Perform a textual comparison.

Remarks
Values greater than 2 can be used to refer to comparisons using specific Locale IDs (LCID). An error occurs if you try to change the comparison mode of a Dictionary object that already contains data.

The CompareMode property uses the same values as the compare argument for the StrComp function.

The following example illustrates use of the CompareMode property:

Dim d           
Set d = CreateObject("Scripting.Dictionary")
d.CompareMode = vbTextCompare
d.Add "a", "Athens"      ' Add some keys and items.
d.Add "b", "Belgrade"
d.Add "c", "Cairo"
d.Add "B", "Baltimore"   ' Add method fails on this line because the 
                         ' letter b already exists in the Dictionary.