DataRowCollection.Find Method (Object)

 

Gets the row specified by the primary key value.

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

Public Function Find (
	key As Object
) As DataRow

Parameters

key
Type: System.Object

The primary key value of the DataRow to find.

Return Value

Type: System.Data.DataRow

A DataRow that contains the primary key value specified; otherwise a null value if the primary key value does not exist in the DataRowCollection.

Exception Condition
MissingPrimaryKeyException

The table does not have a primary key.

To use the Find method, the DataTable object to which the DataRowCollection object belongs must have at least one column designated as a primary key column. See the PrimaryKey property for more information about how to create a primary key column.

The following example uses the Find method to find the primary key value "2" in a collection of DataRow objects. The method returns the specific DataRow object letting you change its values, as needed.

 Private Sub FindInPrimaryKeyColumn(ByVal table As DataTable, _
    ByVal pkValue As Long)
    ' Find the number pkValue in the primary key 
    ' column of the table.
    Dim foundRow As DataRow = table.Rows.Find(pkValue)

    ' Print the value of column 1 of the found row.
    If Not (foundRow Is Nothing) Then
        Console.WriteLine(foundRow(1).ToString())
    End If
End Sub

.NET Framework
Available since 1.1
Return to top
Show: