GetBatchedParameter Method

DbDataAdapter.GetBatchedParameter Method (Int32, Int32)


Returns a IDataParameter from one of the commands in the current batch.

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

protected virtual IDataParameter GetBatchedParameter(
	int commandIdentifier,
	int parameterIndex


Type: System.Int32

The index of the command to retrieve the parameter from.

Type: System.Int32

The index of the parameter within the command.

Return Value

Type: System.Data.IDataParameter

The IDataParameter specified.

Exception Condition

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 execute a batch. An implementation uses the commandIdentifier provided to locate the requested command, then uses the parameterIndex provided to locate the requested parameter. For example, a commandIdentifier of 0 and a parameterIndex of 0 returns the first parameter from the first command in the batch.

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft