SqlDataReader.NextResultAsync(CancellationToken) Method

  • Reference

Definition

Namespace:
Microsoft.Data.SqlClient
Assembly:
Microsoft.Data.SqlClient.dll
Package:
Microsoft.Data.SqlClient v1.0.19269.1
Package:
Microsoft.Data.SqlClient v1.1.4
Package:
Microsoft.Data.SqlClient v2.0.1
Package:
Microsoft.Data.SqlClient v2.1.4
Package:
Microsoft.Data.SqlClient v3.0.1
Package:
Microsoft.Data.SqlClient v3.1.0
Package:
Microsoft.Data.SqlClient v4.0.1
Package:
Microsoft.Data.SqlClient v4.1.0
Package:
Microsoft.Data.SqlClient v5.0.0
Package:
Microsoft.Data.SqlClient v5.1.0
Package:
Microsoft.Data.SqlClient v5.2.0

An asynchronous version of NextResult(), which advances the data reader to the next result, when reading the results of batch Transact-SQL statements.

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> ^ NextResultAsync(System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<bool> NextResultAsync (System.Threading.CancellationToken cancellationToken);
override this.NextResultAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
Public Overrides Function NextResultAsync (cancellationToken As CancellationToken) As Task(Of Boolean)

Parameters

cancellationToken
CancellationToken

The cancellation instruction.

Returns

Task<Boolean>

A task representing the asynchronous operation.

Exceptions

InvalidOperationException

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

SqlException

SQL Server returned an error while executing the command text.

Remarks

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

Applies to