SqlDataReader.ReadAsync Method (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.

An asynchronous version of Read, which advances the SqlDataReader to the next record.

The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.

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

public override Task<bool> ReadAsync(
	CancellationToken cancellationToken


Type: System.Threading.CancellationToken

The cancellation instruction.

Return Value

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

A task representing the asynchronous operation.

Exception Condition

Calling ReadAsync more than once for the same instance before task completion.

Context Connection=true is specified in the connection string.


SQL Server returned an error while executing the command text.

If the behavior parameter of ExecuteReaderAsync is set to Default, ReadAsync reads the entire row before returning the Task.

For more information, including code samples, about asynchronous programming in the .NET Framework Data Provider for SQL Server, see Asynchronous Programming.

.NET Framework
Available since 4.5
Return to top