DbDataReader::NextResultAsync Method (CancellationToken)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

This is the asynchronous version of NextResult. Providers should override with an appropriate implementation. The cancellationToken may optionally be ignored.

The default implementation invokes the synchronous NextResult method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by NextResult will be communicated via the returned Task Exception property.

Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed.

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

public:
virtual Task<bool>^ NextResultAsync(
	CancellationToken cancellationToken
)

Parameters

cancellationToken
Type: System.Threading::CancellationToken

The cancellation instruction.

Return Value

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

A task representing the asynchronous operation.

Exception Condition
DbException

An error occurred while executing the command text.

For more information about asynchronous programming, see Asynchronous Programming.

Universal Windows Platform
Available since 10
.NET Framework
Available since 4.5
Return to top
Show: