Export (0) Print
Expand All

DbCommand.ExecuteScalarAsync Method (CancellationToken)

.NET Framework 4.5

This is the asynchronous version of ExecuteScalar. Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.

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

Do not invoke other methods and properties of the DbCommand object until the returned Task is complete.

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

abstract ExecuteScalarAsync : 
        cancellationToken:CancellationToken -> Task<Object> 
override ExecuteScalarAsync : 
        cancellationToken:CancellationToken -> Task<Object> 

Parameters

cancellationToken
Type: System.Threading.CancellationToken

The token to monitor for cancellation requests.

Return Value

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

ExceptionCondition
DbException

An error occurred while executing the command text.

For more information about asynchronous programming, 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