DbCommand.ExecuteScalarAsync Method

.NET Framework (current version)
 

Implements the asynchronous version of ExecuteScalar, but returns a Task synchronously, blocking the calling thread.

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

NameDescription
System_CAPS_pubmethodExecuteScalarAsync()

An asynchronous version of ExecuteScalar, which executes the query and returns the first column of the first row in the result set returned by the query. All other columns and rows are ignored.

Invokes ExecuteScalarAsync with CancellationToken.None.

System_CAPS_pubmethodExecuteScalarAsync(CancellationToken)

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.

For more information about asynchronous programming, see Asynchronous Programming.

Return to top
Show: