Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

static member Compare : 
        strA:string *
        strB:string *
        comparisonType:StringComparison -> int

Parameters

strA
Type: System.String

The first string to compare.

strB
Type: System.String

The second string to compare.

comparisonType
Type: System.StringComparison

One of the enumeration values that specifies the rules to use in the comparison.

Return Value

Type: System.Int32

A 32-bit signed integer that indicates the lexical relationship between the two comparands.

Value

Condition

Less than zero

strA precedes strB in the sort order.

Zero

strA is in the same position as strB in the sort order.

Greater than zero

strA follows strB in the sort order.

Exception Condition
ArgumentException

comparisonType is not a StringComparison value.

NotSupportedException

StringComparison is not supported.

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".

No code example is currently available or this language may not be supported.

Compare the path name to "file" using an ordinal comparison. The correct code to do this is as follows:

No code example is currently available or this language may not be supported.

Notes to Callers:

Character sets include ignorable characters. The Compare(String, String, StringComparison) method does not consider such characters when it performs a culture-sensitive comparison. To recognize ignorable characters in your comparison, supply a value of StringComparison.Ordinal or OrdinalIgnoreCase for the comparisonType parameter.

The following example compares three versions of the letter "I". The results are affected by the choice of culture, whether case is ignored, and whether an ordinal comparison is performed.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2017 Microsoft