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

Switch View :
Classic
Lightweight
ScriptFree
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)
C#
public DataRow Find (
	Object key
)
C++
public:
DataRow^ Find (
	Object^ key
)
J#
public DataRow Find (
	Object key
)
JScript
public function Find (
	key : Object
) : DataRow
XAML
Not applicable.

Parameters

key

The primary key value of the DataRow to find.

Return Value

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 type 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.

Example

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
C#
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 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
See Also