Export (0) Print
Expand All

DbCommand.ExecuteNonQueryAsync Method (CancellationToken)

.NET Framework 4.5

This is the asynchronous version of ExecuteNonQuery. Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.

The default implementation invokes the synchronous ExecuteNonQuery method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteNonQuery will be communicated via the returned Task Exception property.

Do not invoke other methods and properties of the DbCommand object until the returned Task is complete.

Namespace:  System.Data.Common
Assembly:  System.Data (in System.Data.dll)

'Declaration
Public Overridable Function ExecuteNonQueryAsync ( _
	cancellationToken As CancellationToken _
) As Task(Of Integer)

Parameters

cancellationToken
Type: System.Threading.CancellationToken

The token to monitor for cancellation requests.

Return Value

Type: System.Threading.Tasks.Task(Of Int32)
A task representing the asynchronous operation.

ExceptionCondition
DbException

An error occurred while executing the command text.

For more information about asynchronous programming, see Asynchronous Programming.

.NET Framework

Supported in: 4.6
Show:
© 2014 Microsoft