DataTable.LoadDataRow メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

DataTable.LoadDataRow メソッド (Object[], LoadOption)

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

特定の行を検索し、更新します。一致する行が見つからない場合は、指定した値を使用して新しい行が作成されます。

名前空間: System.Data
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As DataTable
Dim values As Object()
Dim loadOption As LoadOption
Dim returnValue As DataRow

returnValue = instance.LoadDataRow(values, loadOption)

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

C++

public:
DataRow^ LoadDataRow (
    array<Object^>^ values, 
    LoadOption loadOption
)

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

JScript

public function LoadDataRow (
    values : Object[], 
    loadOption : LoadOption
) : DataRow

パラメータ

values: 新しい行の作成に使用する値の配列。

loadOption: 配列値を既存の行にある対応する値に適用する方法を決定するために使用します。

戻り値
新しい DataRow。

解説

LoadDataRow メソッドは、値の配列を取得し、1 つ以上の主キー列内の一致する値を検索します。

列に既定値がある場合は、配列で null 値を渡して、その列の既定値を設定します。同様に、列の AutoIncrement プロパティが true に設定されている場合は、配列で null 値を渡して、その行に自動生成値を設定します。

loadOption パラメータの値を使用して、配列の値を既存の行に適用する方法を決定します。たとえば、loadOption が OverwriteChanges に設定されている場合、各列の Original 値と Current 値は受信した行の値に置き換えられ、RowState プロパティが Unchanged に設定されます。

ColumnChanging イベントまたは RowChanging イベント中に例外が発生することがあります。例外が発生した場合、その行はテーブルに追加されません。

LoadDataRow を BeginLoadData および EndLoadData と組み合わせて使用します。

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
DataTable クラス
DataTable メンバ
System.Data 名前空間
その他の技術情報
DataTable の作成と使用

DataTable.LoadDataRow メソッド (Object[], Boolean)

特定の行を検索し、更新します。一致する行が見つからない場合は、指定した値を使用して新しい行が作成されます。

名前空間: System.Data
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As DataTable
Dim values As Object()
Dim fAcceptChanges As Boolean
Dim returnValue As DataRow

returnValue = instance.LoadDataRow(values, fAcceptChanges)

public DataRow LoadDataRow (
    Object[] values,
    bool fAcceptChanges
)

C++

public:
DataRow^ LoadDataRow (
    array<Object^>^ values, 
    bool fAcceptChanges
)

public DataRow LoadDataRow (
    Object[] values, 
    boolean fAcceptChanges
)

JScript

public function LoadDataRow (
    values : Object[], 
    fAcceptChanges : boolean
) : DataRow

パラメータ

values: 新しい行の作成に使用する値の配列。

fAcceptChanges: 変更を受け入れる場合は true。それ以外の場合は false。

戻り値
新しい DataRow。

例外

例外の種類	条件
ArgumentException	配列がテーブルの列数より大きいです。
InvalidCastException	値が各列の型と一致していません。
ConstraintException	この行を追加すると、制約が無効になります。
NoNullAllowedException	AllowDBNull が false である列に null を格納しようとしています。

解説

LoadDataRow メソッドは、値の配列を取得し、1 つ以上の主キー列内の一致する値を検索します。

fAcceptChanges パラメータが true であるか、指定されていない場合は、新しいデータが追加され、AcceptChanges が呼び出されて DataTable 内のすべての変更が受け入れられます。この引数が false の場合は、新しく追加された行に挿入マークが付けられ、既存の行への変更に変更マークが付けられます。

ColumnChanging イベントまたは RowChanging イベント中に例外が発生することがあります。例外が発生した場合、その行はテーブルに追加されません。

LoadDataRow を BeginLoadData および EndLoadData と組み合わせて使用します。

使用例

LoadDataRow メソッドを使用して行を検索する例を次に示します。行が見つからなかった場合は、値を使用して新しい行が作成されます。

Visual Basic

Private Sub MyAddUpdate(ByVal
 table As DataTable)
    ' Create an array for the values.
    Dim newRow(2) As Object

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

    ' Add the new row to the rows collection.
    row = table.LoadDataRow(newRow, True)
    table.EndLoadData()
End Sub

private void MyAddUpdate(DataTable table)
{
    // 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;
    table.BeginLoadData();

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

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
DataTable クラス
DataTable メンバ
System.Data 名前空間
その他の技術情報
DataTable の作成と使用
DataTable の作成と使用

DataTable.LoadDataRow メソッド

特定の行を検索し、更新します。一致する行が見つからない場合は、指定した値を使用して新しい行が作成されます。
オーバーロードの一覧

名前	説明
DataTable.LoadDataRow (Object[], Boolean)	特定の行を検索し、更新します。一致する行が見つからない場合は、指定した値を使用して新しい行が作成されます。 .NET Compact Framework によってサポートされています。
DataTable.LoadDataRow (Object[], LoadOption)	特定の行を検索し、更新します。一致する行が見つからない場合は、指定した値を使用して新しい行が作成されます。 .NET Compact Framework によってサポートされています。