This documentation is archived and is not being maintained.

DbDataAdapter.GetBatchedParameter Method

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
)

Parameters

commandIdentifier
Type: System.Int32
The index of the command to retrieve the parameter from.
parameterIndex
Type: System.Int32
The index of the parameter within the command.

Return Value

Type: System.Data.IDataParameter
The IDataParameter specified.

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

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: