Export (0) Print
Expand All

SqlConnection.OpenAsync Method (CancellationToken)

.NET Framework 4.5

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.

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

public override Task OpenAsync(
	CancellationToken cancellationToken
)

Parameters

cancellationToken
Type: System.Threading.CancellationToken

The cancellation instruction.

Return Value

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

ExceptionCondition
InvalidOperationException

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

Context Connection=true is specified in the connection string.

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.

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.

.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