Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
ExecuteDbDataReaderAsync Method

DbCommand.ExecuteDbDataReaderAsync Method

.NET Framework 4.6 and 4.5

Providers should implement this method to provide a non-default implementation for ExecuteReader overloads.

The default implementation invokes the synchronous ExecuteReader 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 ExecuteReader will be communicated via the returned Task Exception property.

This method accepts a cancellation token that can be used to request the operation to be cancelled early. Implementations may ignore this request.

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

'Declaration
Protected Overridable Function ExecuteDbDataReaderAsync ( _
	behavior As CommandBehavior, _
	cancellationToken As CancellationToken _
) As Task(Of DbDataReader)

Parameters

behavior
Type: System.Data.CommandBehavior

Options for statement execution and data retrieval.

cancellationToken
Type: System.Threading.CancellationToken

The token to monitor for cancellation requests.

Return Value

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

ExceptionCondition
DbException

An error occurred while executing the command text.

ArgumentException

An invalid CommandBehavior value.

For more information about asynchronous programming, see Asynchronous Programming.

.NET Framework

Supported in: 4.6, 4.5
Show:
© 2015 Microsoft