DbDataAdapter::AddToBatch Method (IDbCommand^)

 
System_CAPS_noteNote

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

Adds a IDbCommand to the current batch.

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

protected:
virtual int AddToBatch(
	IDbCommand^ command
)

Parameters

command
Type: System.Data::IDbCommand^

The IDbCommand to add to the batch.

Return Value

Type: System::Int32

The number of commands in the batch before adding the IDbCommand.

Exception Condition
NotSupportedException

The adapter does not support batches.

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

Notes to Implementers:

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 add a command to a batch.

.NET Framework
Available since 2.0
Return to top
Show: