Returns information about an individual update attempt within a larger batched update.
Namespace:
System.Data.Common
Assembly:
System.Data (in System.Data.dll)
Visual Basic (Declaration)
Protected Overridable Function GetBatchedRecordsAffected ( _
commandIdentifier As Integer, _
<OutAttribute> ByRef recordsAffected As Integer, _
<OutAttribute> ByRef error As Exception _
) As Boolean
Dim commandIdentifier As Integer
Dim recordsAffected As Integer
Dim error As Exception
Dim returnValue As Boolean
returnValue = Me.GetBatchedRecordsAffected(commandIdentifier, _
recordsAffected, error)
protected virtual bool GetBatchedRecordsAffected(
int commandIdentifier,
out int recordsAffected,
out Exception error
)
protected:
virtual bool GetBatchedRecordsAffected(
int commandIdentifier,
[OutAttribute] int% recordsAffected,
[OutAttribute] Exception^% error
)
protected function GetBatchedRecordsAffected(
commandIdentifier : int,
recordsAffected : int,
error : Exception
) : 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 nullNothingnullptra null reference (Nothing in Visual Basic) (Nothing in Visual Basic) if no exception is thrown.
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 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5 SP1, 3.0 SP1, 2.0 SP1
.NET Compact Framework
Supported in: 3.5
XNA Framework
Supported in: 3.0, 2.0
Reference