DataTable.LoadDataRow Method (Object[], LoadOption)

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Finds and updates a specific row. If no matching row is found, a new row is created using the given values.

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

Syntax

C++

public DataRow LoadDataRow(
	object[] values,
	LoadOption loadOption
)

Parameters

values: Type: System.Object[]
An array of values used to create the new row.

loadOption: Type: System.Data.LoadOption
Used to determine how the array values are applied to the corresponding values in an existing row.

Return Value

Type: System.Data.DataRow

The new DataRow.

Remarks

The LoadDataRow method takes an array of values and finds the matching value(s) in the primary key column(s).

If a column has a default value, pass a null value in the array to set the default value for that column. Similarly, if a column has its AutoIncrement property set to true, pass a null value in the array to set the automatically generated value for the row.

The value of the loadOption parameter is used to determine how the values in the array are applied to an existing row. For example, if loadOption is set to OverwriteChanges, the Original and Current values of each column are replaced with the values in the incoming row and the RowState property is set to Unchanged.

Exceptions can also occur during either a ColumnChanging or RowChanging event. If an exception occurs, the row is not added to the table.

Use LoadDataRow in conjunction with BeginLoadData and EndLoadData.

Version Information

.NET Framework
Available since 2.0