Export (0) Print
Expand All

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)

Public Overridable Function ReadAsync ( _
	cancellationToken As CancellationToken _
) As Task(Of Boolean)


Type: System.Threading.CancellationToken

The cancellation instruction.

Return Value

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


An error occurred while executing the command text.

For more information about asynchronous programming, see Asynchronous Programming.

.NET Framework

Supported in: 4.6, 4.5
© 2015 Microsoft