Export (0) Print
Expand All

StructuralComparisons::StructuralEqualityComparer Property

Gets a predefined object that compares two objects for structural equality.

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

public:
static property IEqualityComparer^ StructuralEqualityComparer {
	IEqualityComparer^ get ();
}

Property Value

Type: System.Collections::IEqualityComparer
A predefined object that is used to compare two collection objects for structural equality.

When the IComparer object returned by this property is passed to the equality comparison method of a collection object, such as Array::IStructuralEquatable::Equals(Object, IEqualityComparer) or Tuple<T1, T2, T3>::IStructuralEquatable::Equals(Object, IEqualityComparer), its IEqualityComparer::Equals method is called for each member of an array or for each component of a tuple. This implementation of the Equals method behaves as follows when it compares each item of a collection object with the corresponding item of another collection object:

  • If both items are nullptr, it considers the two items to be equal.

  • If one item is null but the other item is not, it considers the two items to be unequal.

  • If the first item in the comparison can be cast to an IStructuralEquatable object (in other words, if it is a collection object that implements the IStructuralEquatable interface), it calls the IStructuralEquatable::Equals method.

  • If the first item in the comparison cannot be cast to an IStructuralEquatable object (in other words, if it is not a collection object that implements the IStructuralEquatable interface), it calls the item's Equals method.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

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.

Show:
© 2014 Microsoft