IDbDataAdapter.DeleteCommand プロパティ

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

IDbDataAdapter.DeleteCommand プロパティ

データ セットからレコードを削除する SQL ステートメントを取得または設定します。

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

Visual Basic (宣言)

Property DeleteCommand As IDbCommand

Visual Basic (使用法)

Dim instance As IDbDataAdapter
Dim value As IDbCommand

value = instance.DeleteCommand

instance.DeleteCommand = value

C#

IDbCommand DeleteCommand { get; set; }

C++

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

J#

/** @property */
IDbCommand get_DeleteCommand ()

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

JScript

function get DeleteCommand () : IDbCommand

function set DeleteCommand (value : IDbCommand)

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

解説

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

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

使用例

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

Visual Basic

Public Shared Function CreateCustomerAdapter(
 _
    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 CustomerID
 FROM 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 DeleteCommand.
    command = New OleDbCommand( _
        "DELETE * FROM Customers WHERE CustomerID = ?",
 _
        connection)

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

    dataAdapter.DeleteCommand = command

    Return dataAdapter
End Function

C#

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

    // Create the SelectCommand.
    command = new OleDbCommand("SELECT CustomerID FROM 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 DeleteCommand.
    command = new OleDbCommand(
        "DELETE * FROM Customers WHERE CustomerID = ?", 
        connection);

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

    dataAdapter.DeleteCommand = 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 名前空間