DbCommand.PrepareAsync(CancellationToken) 方法

定义

命名空间:

System.Data.Common

程序集:

System.Data.Common.dll

Source:

DbCommand.cs

在数据源上异步创建准备就绪（或已编译）的命令版本。

public virtual System.Threading.Tasks.Task PrepareAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function PrepareAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

参数

cancellationToken

CancellationToken

用于取消异步操作的可选令牌。 默认值为 None。

返回

Task

表示异步操作的 Task。

例外

OperationCanceledException

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

注解

此异步方法的默认实现委托给其同步方法，并返回一个已完成 Task的 ，可能会阻止调用线程。

支持 异步编程 的数据提供程序应使用异步 I/O 操作替代默认实现。

如果 属性 CommandType 设置为 TableDirect，则 PrepareAsync 不执行任何作用。 如果 CommandType 设置为 StoredProcedure，则对 的 PrepareAsync 调用应成功，尽管这可能会导致 no-op。

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