Indicates whether this instance and a specified object are equal.
Assembly: mscorlib (in mscorlib.dll)
Public Overrides Function Equals ( _
obj As [%$TOPIC/2dts52z7_en-us_VS_110_1_0_0_0_0%] _
) As [%$TOPIC/2dts52z7_en-us_VS_110_1_0_0_0_1%]
public override [%$TOPIC/2dts52z7_en-us_VS_110_1_0_1_0_0%] Equals(
[%$TOPIC/2dts52z7_en-us_VS_110_1_0_1_0_1%] obj
)
public:
virtual [%$TOPIC/2dts52z7_en-us_VS_110_1_0_2_0_0%] Equals(
[%$TOPIC/2dts52z7_en-us_VS_110_1_0_2_0_1%]^ obj
) override
abstract Equals :
obj:[%$TOPIC/2dts52z7_en-us_VS_110_1_0_3_0_0%] -> [%$TOPIC/2dts52z7_en-us_VS_110_1_0_3_0_1%]
override Equals :
obj:[%$TOPIC/2dts52z7_en-us_VS_110_1_0_3_0_2%] -> [%$TOPIC/2dts52z7_en-us_VS_110_1_0_3_0_3%]
Parameters
- obj
- Type:
SystemObject
The object to compare with the current instance.
Return Value
Type: SystemBooleantrue if obj and this instance are the same type and represent the same value; otherwise, false.
The ValueTypeEquals(Object) method overrides ObjectEquals(Object) and provides the default implementation of value equality for all value types in the .NET Framework.
If none of the fields of the current instance and obj are reference types, the Equals method performs a byte-by-byte comparison of the two objects in memory. Otherwise, it uses reflection to compare the corresponding fields of obj and this instance.
Tip |
|---|
Particularly if your value type contains fields that are reference types, you should override the Equals(Object) method. This can improve performance and enable you to more closely represent the meaning of equality for the type. |
Notes for the Windows Runtime
When you call the Equals method on a Windows Runtime structure, it provides the default behavior for value types that don’t override Equals. This is part of the support that the .NET Framework provides for the Windows Runtime (see .NET Framework Support for Windows Store Apps and Windows Runtime). Windows Runtime structures can’t override Equals, even if they’re written with C# or Visual Basic, because they can’t have methods. (In addition, structures in the Windows Runtime itself don’t inherit ValueType.) However, they appear to have ToString, Equals, and GetHashCode methods when you use them in your C# or Visual Basic code, and the .NET Framework provides the default behavior for these methods.
The following example demonstrates how the Equals method can be overridden by a derived value type.
Public Structure Complex
Private m_Re As Double
Private m_Im As Double
Public Overloads Function Equals(ob As Object) As Boolean
If TypeOf ob Is Complex Then
Dim c As Complex = CType(ob, Complex)
Return m_Re = c.m_Re And m_Im = c.m_Im
Else
Return False
End If
End Function
Public Overloads Function GetHashCode() As Integer
Return m_Re.GetHashCode() ^ m_Im.GetHashCode()
End Function
End Structure
public struct Complex
{
public double m_Re;
public double m_Im;
public override bool Equals( object ob ){
if( ob is Complex ) {
Complex c = (Complex) ob;
return m_Re==c.m_Re && m_Im==c.m_Im;
}
else {
return false;
}
}
public override int GetHashCode(){
return m_Re.GetHashCode() ^ m_Im.GetHashCode();
}
}
public ref struct Complex
{
public:
double m_Re;
double m_Im;
virtual bool Equals( Object^ ob ) override
{
if ( dynamic_cast<Complex^>(ob) )
{
Complex^ c = dynamic_cast<Complex^>(ob);
return m_Re == c->m_Re && m_Im == c->m_Im;
}
else
{
return false;
}
}
virtual int GetHashCode() override
{
return m_Re.GetHashCode() ^ m_Im.GetHashCode();
}
};
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.
Tip