DbDataAdapter.ClearBatch Method

Definition

Namespace:

System.Data.Common

Assembly:

System.Data.Common.dll

Source:

DbDataAdapter.cs

Removes all IDbCommand objects from the batch.

protected:
 virtual void ClearBatch();

protected virtual void ClearBatch ();

abstract member ClearBatch : unit -> unit
override this.ClearBatch : unit -> unit

Protected Overridable Sub ClearBatch ()

Exceptions

NotSupportedException

The adapter does not support batches.

Remarks

In DbDataAdapter, this method throws NotSupportedException. Classes that inherit from DbDataAdapter override this method to provide support for batches.

Notes to Inheritors

This method is protected and is designed for use by a .NET Framework data provider.

If a class that inherits from DbDataAdapter supports batches, that class overrides this method to allow users to remove all commands from a batch.

See also

• DbProviderFactories (ADO.NET)
• ADO.NET Overview