DbDataAdapter.GetBatchedRecordsAffected(Int32, Int32, Exception) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns information about an individual update attempt within a larger batched update.
protected:
virtual bool GetBatchedRecordsAffected(int commandIdentifier, [Runtime::InteropServices::Out] int % recordsAffected, [Runtime::InteropServices::Out] Exception ^ % error);protected virtual bool GetBatchedRecordsAffected (int commandIdentifier, out int recordsAffected, out Exception? error);protected virtual bool GetBatchedRecordsAffected (int commandIdentifier, out int recordsAffected, out Exception error);abstract member GetBatchedRecordsAffected : int * int * Exception -> bool
override this.GetBatchedRecordsAffected : int * int * Exception -> boolProtected Overridable Function GetBatchedRecordsAffected (commandIdentifier As Integer, ByRef recordsAffected As Integer, ByRef error As Exception) As BooleanParameters
- commandIdentifier
- Int32
The zero-based column ordinal of the individual command within the batch.
- recordsAffected
- Int32
The number of rows affected in the data store by the specified command within the batch.
- error
- Exception
An Exception thrown during execution of the specified command. Returns null (Nothing in Visual Basic) if no exception is thrown.
Returns
Information about an individual update attempt within a larger batched update.
Remarks
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.
