DbConnection.OpenAsync Method

.NET Framework (current version)
 

This method implements an asynchronous version of Open.

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

NameDescription
System_CAPS_pubmethodOpenAsync()

An asynchronous version of Open, which opens a database connection with the settings specified by the ConnectionString. This method invokes the virtual method OpenAsync with CancellationToken.None.

System_CAPS_pubmethodOpenAsync(CancellationToken)

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.

Exception Condition
DbException

An error occurred while opening the connection.

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

Return to top
Show: