SqlDataReader.ReadAsync(CancellationToken) 方法

定义

Read() 的异步版本,将 SqlDataReader 前移到下一条记录。

取消标记可用于在命令超时超过前请求放弃操作。 将通过返回的任务对象报告异常。

public:
 override System::Threading::Tasks::Task<bool> ^ ReadAsync(System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<bool> ReadAsync (System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
Public Overrides Function ReadAsync (cancellationToken As CancellationToken) As Task(Of Boolean)

参数

cancellationToken
CancellationToken

取消指示。

返回

表示异步操作的任务。

例外

在完成任务前,为同一个实例多次调用 ReadAsync(CancellationToken)

在连接字符串中指定 Context Connection=true

执行命令文本时,SQL Server 返回了一个错误。

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

注解

behavior如果 的 ExecuteReaderAsync 参数设置为 DefaultReadAsync则会在返回 Task 之前读取整行。

有关 .NET Framework Data Provider for SQL Server 中异步编程的详细信息(包括代码示例),请参阅异步编程

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

适用于

另请参阅