Find Method (Object[])
Collapse the table of content
Expand the table of content

DataRowCollection.Find Method (Object[])

 

Gets the row that contains the specified primary key values.

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

public DataRow Find(
	object[] keys
)

Parameters

keys
Type: System.Object[]

An array of primary key values to find. The type of the array is Object.

Return Value

Type: System.Data.DataRow

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

Exception Condition
IndexOutOfRangeException

No row corresponds to that index value.

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. When two or more rows have the same primary key value, then the first row found is returned. This occurs when EnforceConstraints is set to false. See the PrimaryKey property for more information about how to create a PrimaryKey column, or an array of DataColumn objects when the table has more than one primary key.

The following example uses the values of an array to find a specific row in a collection of DataRow objects. The method assumes that a DataTable exists with three primary key columns. After creating an array of the values, the code uses the Find method with the array to get the particular object that you want.

private void FindInMultiPKey(DataTable table)
{
    // Create an array for the key values to find.
    object[]findTheseVals = new object[3];

    // Set the values of the keys to find.
    findTheseVals[0] = "John";
    findTheseVals[1] = "Smith";
    findTheseVals[2] = "5 Main St.";

    DataRow foundRow = table.Rows.Find(findTheseVals);
    // Display column 1 of the found row.
    if(foundRow != null)
        Console.WriteLine(foundRow[1]);
}

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