DbDataAdapter.GetBatchedParameter(Int32, Int32) Method

Definition

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

protected:
 virtual System::Data::IDataParameter ^ GetBatchedParameter(int commandIdentifier, int parameterIndex);
protected virtual System.Data.IDataParameter GetBatchedParameter (int commandIdentifier, int parameterIndex);
abstract member GetBatchedParameter : int * int -> System.Data.IDataParameter
override this.GetBatchedParameter : int * int -> System.Data.IDataParameter
Protected Overridable Function GetBatchedParameter (commandIdentifier As Integer, parameterIndex As Integer) As IDataParameter

Parameters

commandIdentifier
Int32

The index of the command to retrieve the parameter from.

parameterIndex
Int32

The index of the parameter within the command.

Returns

Exceptions

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 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.

Applies to

See also