DbDataAdapter.GetBatchedRecordsAffected Method
Returns information about an individual update attempt within a larger batched update.
Namespace: System.Data.Common
Assembly: System.Data (in System.Data.dll)
protected virtual bool GetBatchedRecordsAffected( int commandIdentifier, out int recordsAffected, out Exception error )
Parameters
- commandIdentifier
- Type: System.Int32
The zero-based column ordinal of the individual command within the batch.
- recordsAffected
- Type: System.Int32
The number of rows affected in the data store by the specified command within the batch.
- error
- Type: System.Exception
An Exception thrown during execution of the specified command. Returns null (Nothing in Visual Basic) if no exception is thrown.
Return Value
Type: System.BooleanInformation about an individual update attempt within a larger batched update.
Data providers that support batched updating logic must override a series of virtual methods on the DbDataAdapter class. GetBatchedRecordsAffected represents one of those virtual methods. The DbDataAdapter class relies on GetBatchedRecordsAffected to determine the success or failure of individual update attempts within a batch so it can mark each corresponding DataRow accordingly.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
