SqlDataReader.ReadAsync(CancellationToken) Method

Definition

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Package:

System.Data.SqlClient v4.9.0

Source:

System.Data.SqlClient.notsupported.cs

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.

C#

public override System.Threading.Tasks.Task<bool> ReadAsync(System.Threading.CancellationToken cancellationToken);

Parameters

cancellationToken

CancellationToken

The cancellation instruction.

Returns

Task<Boolean>

A task representing the asynchronous operation.

Exceptions

InvalidOperationException

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

Context Connection=true is specified in the connection string.

SqlException

SQL Server returned an error while executing the command text.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

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.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Read().

Applies to

See also

• ADO.NET Overview