ReadAsync Method (CancellationToken)
Collapse the table of content
Expand the table of content

DbDataReader.ReadAsync Method (CancellationToken)

.NET Framework 4.6 and 4.5

This is the asynchronous version of Read. Providers should override with an appropriate implementation. The cancellationToken may optionally be ignored.

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

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

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

abstract ReadAsync : 
        cancellationToken:CancellationToken -> Task<bool>
override ReadAsync : 
        cancellationToken:CancellationToken -> Task<bool>


Type: System.Threading.CancellationToken

The cancellation instruction.

Return Value

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

A task representing the asynchronous operation.

Exception Condition

An error occurred while executing the command text.

For more information about asynchronous programming, see Asynchronous Programming.

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