DbDataReader.GetSchemaTableAsync(CancellationToken) 方法

定義

命名空間:

System.Data.Common

組件:

System.Data.Common.dll

來源:

DbDataReader.cs

這是 GetSchemaTable() 的非同步版本。 提供者應該覆寫為適當的實作。 您可以選擇性地接受 cancellationToken。 預設實作會叫用同步GetSchemaTable()呼叫並傳回完成的工作。 如果傳遞一個已經被取消的 cancellationToken，預設實作會傳回已取消的工作。 GetSchemaTable() 擲回的例外狀況會透過傳回的工作例外狀況屬性來傳送。

public virtual System.Threading.Tasks.Task<System.Data.DataTable?> GetSchemaTableAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member GetSchemaTableAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.DataTable>
override this.GetSchemaTableAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.DataTable>

Public Overridable Function GetSchemaTableAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of DataTable)

參數

cancellationToken

CancellationToken

取消指令。

傳回

Task<DataTable>

表示非同步作業的工作。

例外狀況

OperationCanceledException

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

備註

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