String.Compare Method (String, String, Boolean)
Updated: January 2011
Compares two specified String objects, ignoring or honoring their case, and returns an integer that indicates their relationship to one another in the sort order.
Assembly: mscorlib (in mscorlib.dll)
public static function Compare( strA : String, strB : String, ignoreCase : boolean ) : int
Return ValueType: System.Int32
A 32-bit signed integer indicating the lexical relationship between the two comparands.
Less than zero
strA is less than strB.
strA equals strB.
Greater than zero
strA is greater than strB.
The comparison uses the current culture to obtain culture-specific information such as casing rules and the alphabetic order of individual characters. For example, a culture could specify that certain combinations of characters be treated as a single character, or uppercase and lowercase characters be compared in a particular way, or that the sorting order of a character depends on the characters that precede or follow it.
The comparison is performed using word sort rules. For more information about word, string, and ordinal sorts, see System.Globalization.CompareOptions.
When comparing strings, you should call the Compare method, which requires that you explicitly specify the type of string comparison that the method uses.
One or both comparands can be a null reference (Nothing in Visual Basic). By definition, any string, including the empty string (""), compares greater than a null reference; and two null references compare equal to each other.
The comparison terminates when an inequality is discovered or both strings have been compared. However, if the two strings compare equal to the end of one string, and the other string has characters remaining, then the string with remaining characters is considered greater. The return value is the result of the last comparison performed.
Unexpected results can occur when comparisons are affected by culture-specific casing rules. For example, in Turkish, the following example yields the wrong results because the file system in Turkish does not use linguistic casing rules for the letter 'i' in "file".
Compare the path name to "file" using an ordinal comparison. The correct code to do this is as follows:
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.