SqlConnection.OpenAsync(CancellationToken) Método

Definición

Una versión asincrónica de Open(), que abre una conexión a bases de datos con los valores de propiedad especificados por ConnectionString.An asynchronous version of Open(), which opens a database connection with the property settings specified by the ConnectionString. Token de cancelación que se puede usar para solicitar que se abandone la operación antes de que transcurra el tiempo de espera de la conexión.The cancellation token can be used to request that the operation be abandoned before the connection timeout elapses. Las excepciones se propagarán mediante la tarea devuelta.Exceptions will be propagated via the returned Task. Si el tiempo de espera de conexión transcurre sin conectar correctamente, la tarea devuelta se marcará como error con una excepción.If the connection timeout time elapses without successfully connecting, the returned Task will be marked as faulted with an Exception. La implementación devuelve una tarea sin bloquear el subproceso de llamada para las conexiones agrupadas y no agrupadas.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

Parámetros

cancellationToken
CancellationToken

Instrucción de cancelación.The cancellation instruction.

Devoluciones

Tarea que representa la operación asíncrona.A task representing the asynchronous operation.

Excepciones

Llamada a OpenAsync(CancellationToken) más de una vez para la misma instancia antes de la finalización de la tarea.Calling OpenAsync(CancellationToken) more than once for the same instance before task completion.

Se especifica Context Connection=true en la cadena de conexión.Context Connection=true is specified in the connection string.

Una conexión del grupo de conexiones no estaba disponible antes de transcurrir el tiempo de espera de conexión.A connection was not available from the connection pool before the connection time out elapsed.

Cualquier error devuelto por SQL Server que se produjo al abrir la conexión.Any error returned by SQL Server that occurred while opening the connection.

Comentarios

Después de llamar a OpenAsync, State debe devolver Connecting hasta que se complete la Task devuelta.After calling OpenAsync, State must return Connecting until the returned Task is completed. A continuación, si la conexión se realizó correctamente, State debe devolver Open.Then, if the connection was successful, State must return Open. Si se produce un error en la conexión, State debe devolver Closed.If the connection fails, State must return Closed.

Una llamada a Close intentará cancelar o cerrar la llamada de OpenAsync correspondiente.A call to Close will attempt to cancel or close the corresponding OpenAsync call.

Para obtener más información sobre la programación asincrónica en el proveedor de datos de .NET Framework para SQL Server, vea programación asincrónica.For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see Asynchronous Programming.

Se aplica a

Consulte también: