DataTable.LoadDataRow Method

Definition

Namespace:

System.Data

Assembly:

System.Data.Common.dll

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

Overloads

LoadDataRow(Object[], Boolean)	Finds and updates a specific row. If no matching row is found, a new row is created using the given values.
LoadDataRow(Object[], LoadOption)	Finds and updates a specific row. If no matching row is found, a new row is created using the given values.

LoadDataRow(Object[], Boolean)

Source:

DataTable.cs

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

public:
 System::Data::DataRow ^ LoadDataRow(cli::array <System::Object ^> ^ values, bool fAcceptChanges);

public System.Data.DataRow LoadDataRow (object?[] values, bool fAcceptChanges);

member this.LoadDataRow : obj[] * bool -> System.Data.DataRow

Public Function LoadDataRow (values As Object(), fAcceptChanges As Boolean) As DataRow

Parameters

values

Object[]

An array of values used to create the new row.

fAcceptChanges

Boolean

true to accept changes; otherwise false.

Returns

DataRow

The new DataRow.

Exceptions

ArgumentException

The array is larger than the number of columns in the table.

InvalidCastException

A value doesn't match its respective column type.

ConstraintException

Adding the row invalidates a constraint.

NoNullAllowedException

Attempting to put a null in a column where AllowDBNull is false.

Examples

The following example uses the LoadDataRow method to attempt to find a row. If no such row is found, the values are used to create a new row.

using System;
using System.Data;

class MyDataSet {
   public static void Main() {
      DataTable dt = new DataTable();

      DataColumn dc1 = new DataColumn("col1");
      DataColumn dc2 = new DataColumn("col2");
      DataColumn dc3 = new DataColumn("col3");

      dt.Columns.Add(dc1);
      dt.Columns.Add(dc2);
      dt.Columns.Add(dc3);

      // Create an array for the values.
      object[] newRow = new object[3];

      // Set the values of the array.
      newRow[0] = "Hello";
      newRow[1] = "World";
      newRow[2] = "two";
      DataRow row;

      dt.BeginLoadData();

      // Add the new row to the rows collection.
      row = dt.LoadDataRow(newRow, true);

      foreach (DataRow dr in dt.Rows) {
         Console.WriteLine(String.Format("Row: {0}, {1}, {2}", dr["col1"], dr["col2"], dr["col3"]));
      }

      dt.EndLoadData();
   }
}

Imports System.Data

Class MyDataSet
   Public Shared Sub Main()
      Dim dt As New DataTable()

      Dim dc1 As New DataColumn("col1")
      Dim dc2 As New DataColumn("col2")
      Dim dc3 As New DataColumn("col3")

      dt.Columns.Add(dc1)
      dt.Columns.Add(dc2)
      dt.Columns.Add(dc3)

      ' Create an array for the values.
      Dim newRow As Object() = New Object(2) {}

      ' Set the values of the array.
      newRow(0) = "Hello"
      newRow(1) = "World"
      newRow(2) = "two"
      Dim row As DataRow

      dt.BeginLoadData()

      ' Add the new row to the rows collection.
      row = dt.LoadDataRow(newRow, True)

      For Each dr As DataRow In dt.Rows
         Console.WriteLine([String].Format("Row: {0}, {1}, {2}", dr("col1"), dr("col2"), dr("col3")))
      Next

      dt.EndLoadData()
   End Sub
End Class

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.

If the fAcceptChanges parameter is true or not specified, the new data is added and then AcceptChanges is called to accept all changes in the DataTable; if the argument is false, newly added rows are marked as insertions, and changes to existing rows are marked as modifications.

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.

See also

• DataTables
• Handling DataTable Events

LoadDataRow(Object[], LoadOption)

Source:

DataTable.cs

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

public:
 System::Data::DataRow ^ LoadDataRow(cli::array <System::Object ^> ^ values, System::Data::LoadOption loadOption);

public System.Data.DataRow LoadDataRow (object?[] values, System.Data.LoadOption loadOption);

member this.LoadDataRow : obj[] * System.Data.LoadOption -> System.Data.DataRow

Public Function LoadDataRow (values As Object(), loadOption As LoadOption) As DataRow

Parameters

values

Object[]

An array of values used to create the new row.

loadOption

LoadOption

Used to determine how the array values are applied to the corresponding values in an existing row.

Returns

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.

See also

• DataTables