SqlCommand.ExecuteReaderAsync 方法

定义

命名空间:

System.Data.SqlClient

程序集:

System.Data.dll

启动此 SqlCommand 描述的 Transact-SQL 语句或存储过程的异步执行。

重载

ExecuteReaderAsync()	ExecuteReader() 的异步版本，它可以将 CommandText 发送到 Connection，并生成 SqlDataReader。 将通过返回的任务对象报告异常。
ExecuteReaderAsync(CommandBehavior)	ExecuteReader(CommandBehavior) 的异步版本，用于将 CommandText 发送到 Connection，并生成一个 SqlDataReader。 将通过返回的任务对象报告异常。
ExecuteReaderAsync(CancellationToken)	ExecuteReader() 的异步版本，它可以将 CommandText 发送到 Connection，并生成 SqlDataReader。 取消标记可用于在命令超时超过前请求放弃操作。 将通过返回的任务对象报告异常。
ExecuteReaderAsync(CommandBehavior, CancellationToken)	ExecuteReader(CommandBehavior) 的异步版本，它可以将 CommandText 发送到 Connection，并生成 SqlDataReader。 取消标记可用于在命令超时超过前请求放弃操作。 将通过返回的任务对象报告异常。

注解

有关 SQL Server .NET Framework 数据提供程序中的异步编程的详细信息，请参阅异步编程。

ExecuteReaderAsync()

ExecuteReader() 的异步版本，它可以将 CommandText 发送到 Connection，并生成 SqlDataReader。 将通过返回的任务对象报告异常。

public:
 System::Threading::Tasks::Task<System::Data::SqlClient::SqlDataReader ^> ^ ExecuteReaderAsync();

public System.Threading.Tasks.Task<System.Data.SqlClient.SqlDataReader> ExecuteReaderAsync ();

override this.ExecuteReaderAsync : unit -> System.Threading.Tasks.Task<System.Data.SqlClient.SqlDataReader>

Public Function ExecuteReaderAsync () As Task(Of SqlDataReader)

返回

Task<SqlDataReader>

表示异步操作的任务。

例外

InvalidCastException

将 Value 设置为 Stream 时，使用的是 SqlDbType 而不是 Binary 或 VarBinary。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

- 或 -

SqlDbType设置为 时ValueTextReader，使用了 Char、NChar、NVarChar、VarChar 或 Xml 以外的其他项。

- 或 -

将 Value 设置为 XmlReader 时，使用的是 SqlDbType 而不是 Xml。

ArgumentException

无效的 CommandBehavior 值。

InvalidOperationException

在完成任务前，为同一个实例多次调用 ExecuteReaderAsync()。

- 或 -

流式处理操作期间关闭或删除了 SqlConnection。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

- 或 -

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

SqlException

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

- 或 -

流式处理操作期间发生了超时。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

IOException

流式处理操作期间在 Stream、XmlReader 或 TextReader 对象中出现了错误。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

ObjectDisposedException

流式处理操作期间关闭了 Stream、XmlReader 或 TextReader 对象。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

注解

有关 SQL Server .NET Framework 数据提供程序中的异步编程的详细信息，请参阅异步编程。

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

另请参阅

• ADO.NET 概述

ExecuteReaderAsync(CommandBehavior)

ExecuteReader(CommandBehavior) 的异步版本，用于将 CommandText 发送到 Connection，并生成一个 SqlDataReader。 将通过返回的任务对象报告异常。

public:
 System::Threading::Tasks::Task<System::Data::SqlClient::SqlDataReader ^> ^ ExecuteReaderAsync(System::Data::CommandBehavior behavior);

public System.Threading.Tasks.Task<System.Data.SqlClient.SqlDataReader> ExecuteReaderAsync (System.Data.CommandBehavior behavior);

override this.ExecuteReaderAsync : System.Data.CommandBehavior -> System.Threading.Tasks.Task<System.Data.SqlClient.SqlDataReader>

Public Function ExecuteReaderAsync (behavior As CommandBehavior) As Task(Of SqlDataReader)

参数

behavior

CommandBehavior

语句执行和数据检索的选项。 当设置为 Default 时，ReadAsync(CancellationToken) 将在返回完整任务前读取整行。

返回

Task<SqlDataReader>

表示异步操作的任务。

例外

InvalidCastException

将 Value 设置为 Stream 时，使用的是 SqlDbType 而不是 Binary 或 VarBinary。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

- 或 -

SqlDbType设置为 时ValueTextReader，使用了 Char、NChar、NVarChar、VarChar 或 Xml 以外的其他项。

- 或 -

将 Value 设置为 XmlReader 时，使用的是 SqlDbType 而不是 Xml。

ArgumentException

无效的 CommandBehavior 值。

InvalidOperationException

在完成任务前，为同一个实例多次调用 ExecuteReaderAsync(CommandBehavior)。

- 或 -

流式处理操作期间关闭或删除了 SqlConnection。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

- 或 -

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

SqlException

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

- 或 -

流式处理操作期间发生了超时。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

IOException

流式处理操作期间在 Stream、XmlReader 或 TextReader 对象中出现了错误。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

ObjectDisposedException

流式处理操作期间关闭了 Stream、XmlReader 或 TextReader 对象。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

注解

有关 SQL Server .NET Framework 数据提供程序中的异步编程的详细信息，请参阅异步编程。

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

另请参阅

• ADO.NET 概述

ExecuteReaderAsync(CancellationToken)

ExecuteReader() 的异步版本，它可以将 CommandText 发送到 Connection，并生成 SqlDataReader。

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

public:
 System::Threading::Tasks::Task<System::Data::SqlClient::SqlDataReader ^> ^ ExecuteReaderAsync(System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Data.SqlClient.SqlDataReader> ExecuteReaderAsync (System.Threading.CancellationToken cancellationToken);

override this.ExecuteReaderAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.SqlClient.SqlDataReader>

Public Function ExecuteReaderAsync (cancellationToken As CancellationToken) As Task(Of SqlDataReader)

参数

cancellationToken

CancellationToken

取消指示。

返回

Task<SqlDataReader>

表示异步操作的任务。

例外

InvalidCastException

将 Value 设置为 Stream 时，使用的是 SqlDbType 而不是 Binary 或 VarBinary。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

- 或 -

SqlDbType设置为 时ValueTextReader，使用了 Char、NChar、NVarChar、VarChar 或 Xml 以外的其他项。

- 或 -

将 Value 设置为 XmlReader 时，使用的是 SqlDbType 而不是 Xml。

ArgumentException

无效的 CommandBehavior 值。

InvalidOperationException

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

- 或 -

流式处理操作期间关闭或删除了 SqlConnection。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

- 或 -

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

SqlException

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

- 或 -

流式处理操作期间发生了超时。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

IOException

流式处理操作期间在 Stream、XmlReader 或 TextReader 对象中出现了错误。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

ObjectDisposedException

流式处理操作期间关闭了 Stream、XmlReader 或 TextReader 对象。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

OperationCanceledException

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

注解

有关 SQL Server .NET Framework 数据提供程序中的异步编程的详细信息，请参阅异步编程。

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

另请参阅

• ADO.NET 概述

ExecuteReaderAsync(CommandBehavior, CancellationToken)

ExecuteReader(CommandBehavior) 的异步版本，它可以将 CommandText 发送到 Connection，并生成 SqlDataReader。

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

public:
 System::Threading::Tasks::Task<System::Data::SqlClient::SqlDataReader ^> ^ ExecuteReaderAsync(System::Data::CommandBehavior behavior, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Data.SqlClient.SqlDataReader> ExecuteReaderAsync (System.Data.CommandBehavior behavior, System.Threading.CancellationToken cancellationToken);

override this.ExecuteReaderAsync : System.Data.CommandBehavior * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.SqlClient.SqlDataReader>

Public Function ExecuteReaderAsync (behavior As CommandBehavior, cancellationToken As CancellationToken) As Task(Of SqlDataReader)

参数

behavior

CommandBehavior

语句执行和数据检索的选项。 当设置为 Default 时，ReadAsync(CancellationToken) 将在返回完整任务前读取整行。

cancellationToken

CancellationToken

取消指令。

返回

Task<SqlDataReader>

表示异步操作的任务。

例外

InvalidCastException

将 Value 设置为 Stream 时，使用的是 SqlDbType 而不是 Binary 或 VarBinary。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

- 或 -

SqlDbType设置为 时ValueTextReader，使用了 Char、NChar、NVarChar、VarChar 或 Xml 以外的其他项。

- 或 -

将 Value 设置为 XmlReader 时，使用的是 SqlDbType 而不是 Xml。

ArgumentException

无效的 CommandBehavior 值。

InvalidOperationException

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

- 或 -

流式处理操作期间关闭或删除了 SqlConnection。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

- 或 -

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

SqlException

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

- 或 -

流式处理操作期间发生了超时。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

IOException

流式处理操作期间在 Stream、XmlReader 或 TextReader 对象中出现了错误。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

ObjectDisposedException

流式处理操作期间关闭了 Stream、XmlReader 或 TextReader 对象。 有关流式处理的详细信息，请参阅 SqlClient 流支持。

OperationCanceledException

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

注解

有关 SQL Server .NET Framework 数据提供程序中的异步编程的详细信息，请参阅异步编程。

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

另请参阅

• ADO.NET 概述