OleDbDataAdapter.DeleteCommand Property


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

Gets or sets an SQL statement or stored procedure for deleting records from the data set.

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

Public Property DeleteCommand As OleDbCommand

Property Value

Type: System.Data.OleDb.OleDbCommand

An OleDbCommand used during Update to delete records in the data source that correspond to deleted rows in the DataSet.

During Update, if this property is not set and primary key information is present in the DataSet, the DeleteCommand can be generated automatically if you set the SelectCommand property and use the OleDbCommandBuilder. Then, any additional commands that you do not set are generated by the OleDbCommandBuilder. This generation logic requires key column information to be present in the DataSet. For more information, see Generating Commands with CommandBuilders.

When DeleteCommand is assigned to a previously created OleDbCommand, the OleDbCommand is not cloned. The DeleteCommand maintains a reference to the previously created OleDbCommand object.

The following example creates an OleDbDataAdapter and sets the SelectCommand and DeleteCommand properties. It assumes that you have already created an OleDbConnection object.

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 = ?", _

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

    dataAdapter.DeleteCommand = command

    Return dataAdapter
End Function

.NET Framework
Available since 1.1
Return to top