DbConnection::OpenAsync Method (CancellationToken)

.NET Framework (current version)

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 Open. Providers should override with an appropriate implementation. The cancellation token can optionally be honored.

The default implementation invokes the synchronous Open call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by Open will be communicated via the returned Task Exception property.

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

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

virtual Task^ OpenAsync(
	CancellationToken cancellationToken


Type: System.Threading::CancellationToken

The cancellation instruction.

Return Value

Type: System.Threading.Tasks::Task^

A task representing the asynchronous operation.

After calling OpenAsync, State must return Connecting until the returned Task is completed. Then, if the connection was successful, State must return Open. If the connection fails, State must return Closed.

A call to Close will attempt to cancel or close the corresponding OpenAsync call.

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

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