This documentation is archived and is not being maintained.
SortKey::Equals Method
Visual Studio 2010
Determines whether the specified object is equal to the current SortKey object.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
- Type: System::Object
The object to compare with the current SortKey object.
Return Value
Type: System::Booleantrue if the value parameter is equal to the current SortKey object; otherwise, false.
| Exception | Condition |
|---|---|
| ArgumentNullException | value is nullptr. |
Two SortKey objects are considered equal if their KeyData properties are equal.
This method overrides Object::Equals.
The following code example shows the results of Equals when compared with different SortKey objects.
using namespace System; using namespace System::Globalization; int main() { // Creates two identical en-US cultures and one de-DE culture. CultureInfo^ MyCI = gcnew CultureInfo( "en-US",false ); CompareInfo^ myComp_enUS1 = MyCI->CompareInfo; MyCI = gcnew CultureInfo( "en-US",false ); CompareInfo^ myComp_enUS2 = MyCI->CompareInfo; MyCI = gcnew CultureInfo( "de-DE",false ); CompareInfo^ myComp_deDE = MyCI->CompareInfo; // Creates the base SortKey to compare with all the others. SortKey^ mySK1 = myComp_enUS1->GetSortKey( "cant", CompareOptions::StringSort ); // Creates a SortKey that is derived exactly the same way as the base SortKey. SortKey^ mySK2 = myComp_enUS1->GetSortKey( "cant", CompareOptions::StringSort ); // Creates a SortKey that uses word sort, which is the default sort. SortKey^ mySK3 = myComp_enUS1->GetSortKey( "cant" ); // Creates a SortKey for a different String*. SortKey^ mySK4 = myComp_enUS1->GetSortKey( "can't", CompareOptions::StringSort ); // Creates a SortKey from a different CompareInfo with the same culture. SortKey^ mySK5 = myComp_enUS2->GetSortKey( "cant", CompareOptions::StringSort ); // Creates a SortKey from a different CompareInfo with a different culture. SortKey^ mySK6 = myComp_deDE->GetSortKey( "cant", CompareOptions::StringSort ); // Compares the base SortKey with itself. Console::WriteLine( "Comparing the base SortKey with itself: {0}", mySK1->Equals( mySK1 ) ); Console::WriteLine(); // Prints the header for the table. Console::WriteLine( "CompareInfo Culture OriginalString CompareOptions Equals()" ); // Compares the base SortKey with a SortKey that is // created from the same CompareInfo with the same String* and the same CompareOptions. Console::WriteLine( "same same same same {0}", mySK1->Equals( mySK2 ) ); // Compares the base SortKey with a SortKey that is // created from the same CompareInfo with the same String* but with different CompareOptions. Console::WriteLine( "same same same different {0}", mySK1->Equals( mySK3 ) ); // Compares the base SortKey with a SortKey that is // created from the same CompareInfo with the different String* // but with the same CompareOptions. Console::WriteLine( "same same different same {0}", mySK1->Equals( mySK4 ) ); // Compares the base SortKey with a SortKey that is // created from a different CompareInfo (same culture) // with the same String* and the same CompareOptions. Console::WriteLine( "different same same same {0}", mySK1->Equals( mySK5 ) ); // Compares the base SortKey with a SortKey that is // created from a different CompareInfo (different culture) // with the same String* and the same CompareOptions. Console::WriteLine( "different different same same {0}", mySK1->Equals( mySK6 ) ); } /* This code produces the following output. Comparing the base SortKey with itself: True CompareInfo Culture OriginalString CompareOptions Equals() same same same same True same same same different False same same different same False different same same same True different different same same False */
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, 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.
Show: