Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

OleDbDataAdapter.DeleteCommand Property

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

[Visual Basic]
Public Shadows Property DeleteCommand As OleDbCommand
[C#]
public new OleDbCommand DeleteCommand {get; set;}
[C++]
public: __property OleDbCommand* get_DeleteCommand();
public: __property void set_DeleteCommand(OleDbCommand*);
[JScript]
public hide function get DeleteCommand() : OleDbCommand;
public function set DeleteCommand(OleDbCommand);

Property Value

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

Remarks

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 Automatically Generated Commands.

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.

Example

[Visual Basic, C#, C++] The following example creates an OleDbDataAdapter and sets the SelectCommand and DeleteCommand properties. It assumes you have already created an OleDbConnection object.

[Visual Basic] 
Public Shared Function CreateCustomerAdapter(conn As OleDbConnection) As OleDbDataAdapter 
  
  Dim da As OleDbDataAdapter = New OleDbDataAdapter()
  Dim cmd As OleDbCommand
  Dim parm As OleDbParameter

  ' Create the SelectCommand.

  cmd = New OleDbCommand("SELECT * FROM Customers " & _
                       "WHERE Country = @Country AND City = @City", conn)

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

  da.SelectCommand = cmd

  ' Create the DeleteCommand.

  cmd = New OleDbCommand("DELETE FROM Customers WHERE CustomerID = @CustomerID", conn)

  parm = cmd.Parameters.Add("@CustomerID", OleDbType.Char, 5, "CustomerID")
  parm.SourceVersion = DataRowVersion.Original

  da.DeleteCommand = cmd

  Return da
End Function

[C#] 
public static OleDbDataAdapter CreateCustomerAdapter(OleDbConnection conn)
{
  OleDbDataAdapter da = new OleDbDataAdapter();
  OleDbCommand cmd;
  OleDbParameter parm;

  // Create the SelectCommand.

  cmd = new OleDbCommand("SELECT * FROM Customers " +
                       "WHERE Country = @Country AND City = @City", conn);

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

  da.SelectCommand = cmd;

  // Create the DeleteCommand.

  cmd = new OleDbCommand("DELETE FROM Customers WHERE CustomerID = @CustomerID", conn);

  parm = cmd.Parameters.Add("@CustomerID", OleDbType.Char, 5, "CustomerID");
  parm.SourceVersion = DataRowVersion.Original;

  da.DeleteCommand = cmd;

  return da;
}

[C++] 
public:
static OleDbDataAdapter* CreateCustomerAdapter(OleDbConnection* conn)
{
  OleDbDataAdapter* da = new OleDbDataAdapter();
  OleDbCommand* cmd;
  OleDbParameter* parm;

  // Create the SelectCommand.

  cmd = new OleDbCommand(S"SELECT * FROM Customers " 
                       S"WHERE Country = @Country AND City = @City", conn);

  cmd->Parameters->Add(S"@Country", OleDbType::VarChar, 15);
  cmd->Parameters->Add(S"@City", OleDbType::VarChar, 15);

  da->SelectCommand = cmd;

  // Create the DeleteCommand.

  cmd = new OleDbCommand(S"DELETE FROM Customers WHERE CustomerID = @CustomerID", conn);

  parm = cmd->Parameters->Add(S"@CustomerID", OleDbType::Char, 5, S"CustomerID");
  parm->SourceVersion = DataRowVersion::Original;

  da->DeleteCommand = cmd;

  return da;
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

OleDbDataAdapter Class | OleDbDataAdapter Members | System.Data.OleDb Namespace | InsertCommand | SelectCommand | UpdateCommand

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.