DbConnection.ChangeDatabaseAsync(String, CancellationToken) 方法

定義

命名空間:

System.Data.Common

組件:

System.Data.Common.dll

來源:

DbConnection.cs

以非同步方式針對開啟的連線變更目前的資料庫。

public virtual System.Threading.Tasks.Task ChangeDatabaseAsync (string databaseName, System.Threading.CancellationToken cancellationToken = default);

abstract member ChangeDatabaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.ChangeDatabaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function ChangeDatabaseAsync (databaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task

參數

databaseName

String

連線要使用之資料庫的名稱。

cancellationToken

CancellationToken

取消非同步作業的選擇性語彙基元。 預設值是 None。

傳回

Task

表示非同步作業的工作。

例外狀況

OperationCanceledException

取消標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

參數中 databaseName 提供的值必須是目前實例的有效資料庫名稱。

這個異步方法的預設實作會委派給其同步對應專案，並傳回已完成 Task的 ，可能會封鎖呼叫線程。

支援 異步程式設計 的數據提供者應該使用異步 I/O 作業覆寫預設實作。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 ChangeDatabase(String)例外狀況。