DbDataSource.OpenConnectionAsync(CancellationToken) 方法

定义

命名空间:

System.Data.Common

程序集:

System.Data.Common.dll

Source:

DbDataSource.cs

以异步方式返回与此 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)

参数

cancellationToken

CancellationToken

用于取消异步操作的令牌。

返回

ValueTask<DbConnection>

与由此 DbDataSource表示的数据库建立新的开放连接。

例外

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

返回的连接已打开，可供立即使用。

调用方负责正确释放此方法返回的连接。 否则可能会导致连接泄漏。

此方法将存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 OpenConnection()异常。