DbDataSource.OpenConnectionAsync(CancellationToken) Método

Definição

Namespace:

System.Data.Common

Assembly:

System.Data.Common.dll

Origem:

DbDataSource.cs

Retorna de forma assíncrona uma nova conexão aberta com o banco de dados representado por este DbDataSource.

public System.Threading.Tasks.ValueTask<System.Data.Common.DbConnection> OpenConnectionAsync (System.Threading.CancellationToken cancellationToken = default);

member this.OpenConnectionAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Data.Common.DbConnection>

Public Function OpenConnectionAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of DbConnection)

Parâmetros

cancellationToken

CancellationToken

Um token para cancelar a operação assíncrona.

Retornos

ValueTask<DbConnection>

Uma nova conexão aberta com o banco de dados representado por este DbDataSource.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

A conexão retornada já está aberta e está pronta para uso imediato.

É responsabilidade do chamador descartar corretamente a conexão retornada por esse método. A falha ao fazer isso pode resultar em um vazamento de conexão.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por OpenConnection().