String::Compare Method (String, String, CultureInfo, CompareOptions)
Compares 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 strings to each other in the sort order.
Assembly: mscorlib (in mscorlib.dll)
public: static int Compare( String^ strA, String^ strB, CultureInfo^ culture, CompareOptions options )
Parameters
- strA
- Type: System::String
The first string to compare.
- strB
- Type: System::String
The second string to compare.
- culture
- Type: System.Globalization::CultureInfo
The culture 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::Int32A 32-bit signed integer that indicates the lexical relationship between strA and strB, as shown in the following table
Value | Condition |
|---|---|
Less than zero | strA is less than strB. |
Zero | strA equals strB. |
Greater than zero | strA is greater than strB. |
| Exception | Condition |
|---|---|
| ArgumentException | options is not a CompareOptions value. |
| ArgumentNullException | culture is nullptr. |
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 |
|---|
The Compare(String, String, 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 strings 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. |
The comparison can be further specified by the options parameter, which consists of one or more members of the 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.
Either or both comparands 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 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 the remaining characters is considered greater.
The following example compares two strings in three different ways: using linguistic comparison for the en-US culture; using linguistic case-sensitive comparison for the en-US culture; and using an ordinal comparison. It illustrates how the three methods of comparison produce three different results.
using namespace System; using namespace System::Globalization; public ref class Example { public: static void Main() { String^ string1 = "brother"; String^ string2 = "Brother"; String^ relation; int result; // Cultural (linguistic) comparison. result = String::Compare(string1, string2, gcnew CultureInfo("en-US"), CompareOptions::None); if (result > 0) relation = "comes after"; else if (result == 0) relation = "is the same as"; else relation = "comes before"; Console::WriteLine("'{0}' {1} '{2}'.", string1, relation, string2); // Cultural (linguistic) case-insensitive comparison. result = String::Compare(string1, string2, gcnew CultureInfo("en-US"), CompareOptions::IgnoreCase); if (result > 0) relation = "comes after"; else if (result == 0) relation = "is the same as"; else relation = "comes before"; Console::WriteLine("'{0}' {1} '{2}'.", string1, relation, string2); // Culture-insensitive ordinal comparison. result = String::CompareOrdinal(string1, string2); if (result > 0) relation = "comes after"; else if (result == 0) relation = "is the same as"; else relation = "comes before"; Console::WriteLine("'{0}' {1} '{2}'.", string1, relation, string2); } }; int main() { Example::Main(); } // The example produces the following output: // 'brother' comes before 'Brother'. // 'brother' is the same as 'Brother'. // 'brother' comes after 'Brother'.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Caution