DataRowCollection.Find Method (Object) (System.Data)

.NET Framework Class Library

DataRowCollection..::.Find Method (Object)

Gets the row specified by the primary key value.

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

Syntax

Visual Basic (Declaration)

Public Function Find ( _
    key As Object _
) As DataRow

Visual Basic (Usage)

Dim instance As DataRowCollection
Dim key As Object
Dim returnValue As DataRow

returnValue = instance.Find(key)

public DataRow Find(
    Object key
)

Visual C++

public:
DataRow^ Find(
    Object^ key
)

JScript

public function Find(
    key : Object
) : 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.

Exceptions

Exception	Condition
MissingPrimaryKeyException	The table does not have a primary key.

Remarks

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.

Examples

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.

Visual Basic

 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

private void FindInPrimaryKeyColumn(DataTable table, 
    long pkValue)
{
    // Find the number pkValue in the primary key 
    // column of the table.
    DataRow foundRow = table.Rows.Find(pkValue);

    // Print the value of column 1 of the found row.
    if(foundRow != null)
        Console.WriteLine(foundRow[1]);
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

DataRowCollection Class

DataRowCollection Members

Find Overload

System.Data Namespace

DataTable

PrimaryKey

Contains