DbDataReader.GetSchemaTableAsync(CancellationToken) 方法

定义

命名空间:

System.Data.Common

程序集:

System.Data.Common.dll

Source:

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()异常。