String.Compare Method (String, String, StringComparison)
Compares two specified String objects using the specified rules, and returns an integer that indicates their relative position in the sort order.
Assembly: mscorlib (in mscorlib.dll)
static member Compare : strA:string * strB:string * comparisonType:StringComparison -> int
The first string to compare.
The second string to compare.
One of the enumeration values that specifies the rules to use in the comparison.
Return ValueType: System.Int32
A 32-bit signed integer that indicates the lexical relationship between the two comparands.
Less than zero
strA precedes strB in the sort order.
strAis in the same position as strB in the sort order.
Greater than zero
strAfollows strB in the sort order.
The comparisonType parameter indicates whether the comparison should use the current or invariant culture, honor or ignore the case of the comparands, or use word (culture-sensitive) or ordinal (culture-insensitive) sort rules.
One or both comparands can be null. 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, 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:
Notes to Callers:
Available since 4.5
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Available since 8.1