SqlConnection.OpenAsync(CancellationToken) Method

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

An asynchronous version of Open(), which opens a database connection with the property settings specified by the ConnectionString. The cancellation token can be used to request that the operation be abandoned before the connection timeout elapses. Exceptions will be propagated via the returned Task. If the connection timeout time elapses without successfully connecting, the returned Task will be marked as faulted with an Exception. The implementation returns a Task without blocking the calling thread for both pooled and non-pooled connections.

public:
 override System::Threading::Tasks::Task ^ OpenAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task OpenAsync (System.Threading.CancellationToken cancellationToken);

override this.OpenAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function OpenAsync (cancellationToken As CancellationToken) As Task

Parameters

cancellationToken

CancellationToken

The cancellation instruction.

Returns

Task

A task representing the asynchronous operation.

Exceptions

InvalidOperationException

Calling OpenAsync(CancellationToken) more than once for the same instance before task completion.

A connection was not available from the connection pool before the connection time out elapsed.

SqlException

Any error returned by SQL Server that occurred while opening the connection.

Remarks

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.