Export (0) Print
Expand All

SqlDataReader.ReadAsync Method (CancellationToken)

.NET Framework 4.5

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)

'Declaration
Public Overrides Function ReadAsync ( _
	cancellationToken As CancellationToken _
) As Task(Of Boolean)

Parameters

cancellationToken
Type: System.Threading.CancellationToken

The cancellation instruction.

Return Value

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

ExceptionCondition
InvalidOperationException

Calling ReadAsync 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.

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

Supported in: 4.5.2, 4.5.1, 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft