Export (0) Print
Expand All

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)

'Declaration
Protected Overridable Function GetBatchedRecordsAffected ( _
	commandIdentifier As Integer, _
	<OutAttribute> ByRef recordsAffected As Integer, _
	<OutAttribute> ByRef error As Exception _
) As Boolean

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 Nothing (Nothing in Visual Basic) if no exception is thrown.

Return Value

Type: System.Boolean
Information 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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5 SP1, 3.0 SP1, 2.0 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0
Show:
© 2015 Microsoft