SqlDataReader.ReadAsync(CancellationToken) SqlDataReader.ReadAsync(CancellationToken) SqlDataReader.ReadAsync(CancellationToken) Method

Definition

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.

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

Parameters

cancellationToken
CancellationToken CancellationToken CancellationToken

The cancellation instruction.

Returns

A task representing the asynchronous operation.

Exceptions

Calling ReadAsync(CancellationToken) 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.

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.

Applies to

See also