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, Int32, String, Int32, Int32, Boolean, CultureInfo)

 

Compares substrings of two specified String objects, ignoring or honoring their case and using culture-specific information to influence the comparison, 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 *
        indexA:int *
        strB:string *
        indexB:int *
        length:int *
        ignoreCase:bool *
        culture:CultureInfo -> int

Parameters

strA
Type: System.String

The first string to use in the comparison.

indexA
Type: System.Int32

The position of the substring within strA.

strB
Type: System.String

The second string to use in the comparison.

indexB
Type: System.Int32

The position of the substring within strB.

length
Type: System.Int32

The maximum number of characters in the substrings to compare.

ignoreCase
Type: System.Boolean

true to ignore case during the comparison; otherwise, false.

culture
Type: System.Globalization.CultureInfo

An object that supplies culture-specific comparison information.

Return Value

Type: System.Int32

An integer that indicates the lexical relationship between the two comparands.

Value

Condition

Less than zero

The substring in strA precedes the substring in strB in the sort order.

Zero

The substrings occur in the same position in the sort order, or length is zero.

Greater than zero

The substring in strA follows the substring in strB in the sort order.

Exception Condition
ArgumentOutOfRangeException

indexA is greater than strA.Length.

-or-

indexB is greater than strB.Length.

-or-

indexA, indexB, or length is negative.

-or-

Either strA or strB is null, and length is greater than zero.

ArgumentNullException

culture is null.

The substrings to compare start in strA at indexA, and in strB at indexB. Both indexA and indexB are zero-based; that is, the first character in strA and strB is at position zero, not position one. The length of the first substring is equal to the length of strA minus indexA plus one. The length of the second substring is equal to the length of strB minus indexB plus one.

The number of characters to compare is the lesser of the lengths of the two substrings, and length. The indexA, indexB, and length parameters must be nonnegative.

The comparison uses the culture parameter 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.

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

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, Int32, String, Int32, Int32, Boolean, CultureInfo) method does not consider these characters when it performs a linguistic or culture-sensitive comparison. To recognize ignorable characters in your comparison, call the Compare(String, Int32, String, Int32, Int32, CultureInfo, CompareOptions) method and supply a value of CompareOptions.Ordinal or CompareOptions.OrdinalIgnoreCase for the options parameter.

The following example compares two substrings using different cultures and ignoring the case of the substrings. The choice of culture affects how the letter "I" is compared.

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

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft