DbCommand.ExecuteDbDataReaderAsync Method (CommandBehavior, CancellationToken)

.NET Framework (current version)

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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)

protected virtual Task<DbDataReader> ExecuteDbDataReaderAsync(
	CommandBehavior behavior,
	CancellationToken cancellationToken


Type: System.Data.CommandBehavior

Options for statement execution and data retrieval.

Type: System.Threading.CancellationToken

The token to monitor for cancellation requests.

Return Value

Type: System.Threading.Tasks.Task<DbDataReader>

A task representing the asynchronous operation.

Exception Condition

An error occurred while executing the command text.


An invalid CommandBehavior value.

For more information about asynchronous programming, see Asynchronous Programming.

Universal Windows Platform
Available since 10
.NET Framework
Available since 4.5
Return to top