Expression::Equal Method (Expression^, Expression^)

 

Creates a BinaryExpression that represents an equality comparison.

Namespace:   System.Linq.Expressions
Assembly:  System.Core (in System.Core.dll)

public:
static BinaryExpression^ Equal(
	Expression^ left,
	Expression^ right
)

Parameters

left
Type: System.Linq.Expressions::Expression^

An Expression to set the Left property equal to.

right
Type: System.Linq.Expressions::Expression^

An Expression to set the Right property equal to.

Return Value

Type: System.Linq.Expressions::BinaryExpression^

A BinaryExpression that has the NodeType property equal to Equal and the Left and Right properties set to the specified values.

Exception Condition
ArgumentNullException

left or right is null.

InvalidOperationException

The equality operator is not defined for left.Type and right.Type.

The resulting BinaryExpression has the Method property set to the implementing method. The Type property is set to the type of the node. If the node is lifted, the IsLifted property is true. Otherwise, it is false. The IsLiftedToNull property is always false. The following information describes the implementing method, the node type, and whether a node is lifted.

The following rules determine the implementing method for the operation:

  • If the Type property of either left or right represents a user-defined type that overloads the equality operator, the MethodInfo that represents that method is the implementing method.

  • Otherwise, the implementing method is null.

If the implementing method is not null:

  • If left.Type and right.Type are assignable to the corresponding argument types of the implementing method, the node is not lifted. The type of the node is the return type of the implementing method.

  • If the following two conditions are satisfied, the node is lifted and the type of the node is Boolean:

    • left.Type and right.Type are both value types of which at least one is nullable and the corresponding non-nullable types are equal to the corresponding argument types of the implementing method.

    • The return type of the implementing method is Boolean.

If the implementing method is null:

  • If left.Type and right.Type are both non-nullable, the node is not lifted. The type of the node is Boolean.

  • If left.Type and right.Type are both nullable, the node is lifted. The type of the node is Boolean.

The following code example shows how to create an expression that checks whether the values of its two arguments are equal.

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: