DbCommand::ExecuteDbDataReaderAsync Method (CommandBehavior, CancellationToken)
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.
Assembly: System.Data (in System.Data.dll)
protected: virtual Task<DbDataReader^>^ ExecuteDbDataReaderAsync( CommandBehavior behavior, CancellationToken cancellationToken )
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<DbDataReader^>^A task representing the asynchronous operation.
| Exception | Condition |
|---|---|
| DbException | An error occurred while executing the command text. |
| ArgumentException | An invalid CommandBehavior value. |
For more information about asynchronous programming, see Asynchronous Programming.
Available since 10
.NET Framework
Available since 4.5