Equals Method
Collapse the table of content
Expand the table of content

ForeignKeyConstraint.Equals Method (Object)


Gets a value indicating whether the current ForeignKeyConstraint is identical to the specified object.

Namespace:   System.Data
Assembly:  System.Data (in System.Data.dll)

Public Overrides Function Equals (
	key As Object
) As Boolean


Type: System.Object

The object to which this ForeignKeyConstraint is compared. Two ForeignKeyConstraint are equal if they constrain the same columns.

Return Value

Type: System.Boolean

true, if the objects are identical; otherwise, false.

The following example creates a new ForeignKeyConstraint and checks it against other collection members with the Equals method before adding it to a ConstraintCollection.

Private Sub CreateConstraint(dataSet As DataSet)
    ' Create the ForignKeyConstraint with two DataColumn objects.
    Dim parentCol As DataColumn = _
    Dim childCol As DataColumn = _
    Dim fkeyConstraint As _
       New ForeignKeyConstraint("fkConstraint", parentCol, childCol)

    ' Test against existing members using the Equals method.
    Dim testConstraint As ForeignKeyConstraint
    For Each testConstraint In  dataSet.Tables("Orders").Constraints
        If fkeyConstraint.Equals(testConstraint) Then
            Console.WriteLine("Identical ForeignKeyConstraint!")
            ' Insert code to delete the duplicate object, 
            ' or stop the procedure.
        End If
    Next testConstraint
End Sub

.NET Framework
Available since 1.1
Return to top
© 2016 Microsoft