IDbDataAdapter.UpdateCommand プロパティ

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

IDbDataAdapter.UpdateCommand プロパティ

データ ソース内のレコードを更新する SQL ステートメントを取得または設定します。

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

Visual Basic (宣言)

Property UpdateCommand As IDbCommand

Visual Basic (使用法)

Dim instance As IDbDataAdapter
Dim value As IDbCommand

value = instance.UpdateCommand

instance.UpdateCommand = value

C#

IDbCommand UpdateCommand { get; set; }

C++

property IDbCommand^ UpdateCommand {
    IDbCommand^ get ();
    void set (IDbCommand^ value);
}

J#

/** @property */
IDbCommand get_UpdateCommand ()

/** @property */
void set_UpdateCommand (IDbCommand value)

JScript

function get UpdateCommand () : IDbCommand

function set UpdateCommand (value : IDbCommand)

プロパティ値
データ セット内の変更された行に対応するデータ ソース内のレコードを更新するために、Update 中に使用する IDbCommand。

解説

Update 中、このプロパティが設定されておらず、主キー情報が DataSet 内に存在する場合は、.NET Framework データ プロバイダの SelectCommand プロパティを設定すると、UpdateCommand が自動的に生成されます。次に、設定しなかった追加のコマンドが、CommandBuilder によって生成されます。この生成ロジックでは、DataSet 内にキー列情報が存在している必要があります。詳細については、「コマンドの自動生成」を参照してください。

作成済みの IDbCommand に UpdateCommand が割り当てられた場合、IDbCommand のクローンは作成されません。UpdateCommand によって、作成済みの IDbCommand オブジェクトへの参照が維持されます。

メモ
このコマンドの実行によって行が返された場合は、これらの行が DataSet に追加されます。

使用例

継承した OleDbDataAdapter クラスのインスタンスを作成し、SelectCommand プロパティと UpdateCommand プロパティを設定する例を次に示します。ここでは、OleDbConnection オブジェクトが既に作成されていることを前提にしています。

Visual Basic

Private Function CreateCustomerAdapter( _
    ByVal connection As OleDbConnection) As
 OleDbDataAdapter

    Dim dataAdapter As OleDbDataAdapter = New
 OleDbDataAdapter()
    Dim command As OleDbCommand
    Dim parameter As OleDbParameter

    ' Create the SelectCommand.
    command = New OleDbCommand("SELECT * FROM
 dbo.Customers " & _
        "WHERE Country = ? AND City = ?", connection)

    command.Parameters.Add("Country", OleDbType.VarChar,
 15)
    command.Parameters.Add("City", OleDbType.VarChar,
 15)

    dataAdapter.SelectCommand = command

    ' Create the UpdateCommand.
    command = New OleDbCommand("UPDATE dbo.Customers
 " & _
        "SET CustomerID = ?, CompanyName = ? " &
 _
        "WHERE CustomerID = ?", connection)

    command.Parameters.Add( _
        "CustomerID", OleDbType.Char, 5, "CustomerID")
    command.Parameters.Add( _
        "CompanyName", OleDbType.VarChar, 40, "CompanyName")

    parameter = command.Parameters.Add( _
        "oldCustomerID", OleDbType.Char, 5, "CustomerID")
    parameter.SourceVersion = DataRowVersion.Original

    dataAdapter.UpdateCommand = command

    Return dataAdapter
End Function

C#

private static OleDbDataAdapter CreateCustomerAdapter(
    OleDbConnection connection)
{
    OleDbDataAdapter dataAdapter = new OleDbDataAdapter();
    OleDbCommand command;
    OleDbParameter parameter;

    // Create the SelectCommand.
    command = new OleDbCommand("SELECT * FROM dbo.Customers
 " +
        "WHERE Country = ? AND City = ?", connection);

    command.Parameters.Add("Country", OleDbType.VarChar, 15);
    command.Parameters.Add("City", OleDbType.VarChar, 15);

    dataAdapter.SelectCommand = command;

    // Create the UpdateCommand.
    command = new OleDbCommand(
        "UPDATE dbo.Customers SET CustomerID = ?, CompanyName = ? " +
        "WHERE CustomerID = ?", connection);

    command.Parameters.Add(
        "CustomerID", OleDbType.Char, 5, "CustomerID");
    command.Parameters.Add(
        "CompanyName", OleDbType.VarChar, 40, "CompanyName");

    parameter = command.Parameters.Add(
        "oldCustomerID", OleDbType.Char, 5, "CustomerID");
    parameter.SourceVersion = DataRowVersion.Original;

    dataAdapter.UpdateCommand = command;

    return dataAdapter;
}

プラットフォーム

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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
IDbDataAdapter インターフェイス
IDbDataAdapter メンバ
System.Data 名前空間