String::Compare Method (String, Int32, String, Int32, Int32, CultureInfo, CompareOptions)

Compares substrings of two specified String objects using the specified comparison options and culture-specific information to influence the comparison, and returns an integer that indicates the relationship of the two substrings to each other in the sort order.

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

public:
static int Compare(
	String^ strA, 
	int indexA, 
	String^ strB, 
	int indexB, 
	int length, 
	CultureInfo^ culture, 
	CompareOptions options
)

Parameters

strA
Type: System::String

The first string to use in the comparison.

indexA
Type: System::Int32

The starting position of the substring within strA.

strB
Type: System::String

The second string to use in the comparison.

indexB
Type: System::Int32

The starting position of the substring within strB.

length
Type: System::Int32

The maximum number of characters in the substrings to compare.

culture
Type: System.Globalization::CultureInfo

An object that supplies culture-specific comparison information.

options
Type: System.Globalization::CompareOptions

Options to use when performing the comparison (such as ignoring case or symbols).

Return Value

Type: System::Int32
An integer that indicates the lexical relationship between the two substrings, as shown in the following table.

Value

Condition

Less than zero

The substring in strA is less than the substring in strB.

Zero

The substrings are equal or length is zero.

Greater than zero

The substring in strA is greater than the substring in strB.

ExceptionCondition
ArgumentException

options is not a CompareOptions value.

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 nullptr, and length is greater than zero.

ArgumentNullException

culture is nullptr.

The substrings to compare start in strA at position indexA and in strB at position indexB. The length of the first substring is the length of strA minus indexA. The length of the second substring is the length of strB minus indexB.

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 alphabetical order of individual characters. For example, a particular culture could specify that certain combinations of characters be treated as a single character, that uppercase and lowercase characters be compared in a particular way, or that the sort order of a character depends on the characters that precede or follow it.

Caution noteCaution

The Compare(String, Int32, String, Int32, Int32, CultureInfo, CompareOptions) method is designed primarily for use in sorting or alphabetizing operations. It should not be used when the primary purpose of the method call is to determine whether two substrings are equivalent (that is, when the purpose of the method call is to test for a return value of zero). To determine whether two strings are equivalent, call the Equals method.

One or both of strA and strB can be nullptr. By definition, any string, including String::Empty, compares greater than a null reference, and two null references compare equal to each other.

The comparison can be further specified by the options parameter, which consists of one or more members of the System.Globalization::CompareOptions enumeration. However, because the purpose of this method is to conduct a culture-sensitive string comparison, the CompareOptions::Ordinal and CompareOptions::OrdinalIgnoreCase values have no effect.

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, the string with the remaining characters is considered greater. The return value is the result of the last comparison performed.

Notes to Callers

Character sets include ignorable characters. The Compare(String, Int32, String, Int32, Int32, CultureInfo, CompareOptions) method does not consider these characters when it performs a linguistic or culture-sensitive comparison. To recognize ignorable characters in your comparison, supply a value of CompareOptions::Ordinal or CompareOptions::OrdinalIgnoreCase for the options parameter.

The following example uses the Compare(String, Int32, String, Int32, Int32, CultureInfo, CompareOptions) method to compare the last names of two people. It then lists them in alphabetical order.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5 SP1, 3.0 SP2, 2.0 SP2

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft