SqlCommand.ExecuteReaderAsync 方法
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
重载
| ExecuteReaderAsync() |
的 ExecuteReader() 异步版本，它将 发送到 CommandTextConnection 并生成 SqlDataReader 。 将通过返回的任务对象报告异常。 |
| ExecuteReaderAsync(CommandBehavior) |
的 ExecuteReader(CommandBehavior) 异步版本，它将 发送到 CommandTextConnection ，并生成 SqlDataReader 。 将通过返回的任务对象报告异常。 |
| ExecuteReaderAsync(CancellationToken) |
的 ExecuteReader() 异步版本，它将 发送到 CommandTextConnection 并生成 SqlDataReader 。 取消标记可用于在命令超时超过前请求放弃操作。 将通过返回的任务对象报告异常。 |
| ExecuteReaderAsync(CommandBehavior, CancellationToken) |
的 ExecuteReader(CommandBehavior) 异步版本，它将 发送到 CommandTextConnection ，并生成一个 SqlDataReader 取消令牌可用于请求在命令超时之前放弃操作。 将通过返回的任务对象报告异常。 |
ExecuteReaderAsync()
的 ExecuteReader() 异步版本，它将 发送到 CommandTextConnection 并生成 SqlDataReader 。 将通过返回的任务对象报告异常。
public:
System::Threading::Tasks::Task<Microsoft::Data::SqlClient::SqlDataReader ^> ^ ExecuteReaderAsync();public System.Threading.Tasks.Task<Microsoft.Data.SqlClient.SqlDataReader> ExecuteReaderAsync ();override this.ExecuteReaderAsync : unit -> System.Threading.Tasks.Task<Microsoft.Data.SqlClient.SqlDataReader>Public Function ExecuteReaderAsync () As Task(Of SqlDataReader)返回
表示异步操作的任务。
例外
当 SqlDbType 设置为 Stream 时Value，使用了 Binary 或 VarBinary 以外的 。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
- 或 -
设置为 SqlDbType 时ValueTextReader ，使用了 Char、NChar、NVarChar、VarChar 或 Xml 以外的 。
-或-
无效的 CommandBehavior 值。
在完成任务前，为同一个实例多次调用 ExecuteReaderAsync()。
- 或 -
流式处理操作期间关闭或删除了 SqlConnection。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
在流式处理操作期间， XmlReader 或 TextReader 对象中Stream发生错误。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
在 Stream 流式处理操作期间关闭了 、 XmlReader 或 TextReader 对象。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
注解
有关 .NET Framework Data Provider for SQL Server 中异步编程的详细信息，请参阅异步编程。
注意
对于服务器上长时间运行的查询，请考虑使用 ExecuteReader ，因为存在通过取消令牌取消查询的已知问题。 此外，请考虑使用 Cancel 方法取消执行。
适用于
ExecuteReaderAsync(CommandBehavior)
的 ExecuteReader(CommandBehavior) 异步版本，它将 发送到 CommandTextConnection ，并生成 SqlDataReader 。 将通过返回的任务对象报告异常。
public:
System::Threading::Tasks::Task<Microsoft::Data::SqlClient::SqlDataReader ^> ^ ExecuteReaderAsync(System::Data::CommandBehavior behavior);public System.Threading.Tasks.Task<Microsoft.Data.SqlClient.SqlDataReader> ExecuteReaderAsync (System.Data.CommandBehavior behavior);override this.ExecuteReaderAsync : System.Data.CommandBehavior -> System.Threading.Tasks.Task<Microsoft.Data.SqlClient.SqlDataReader>Public Function ExecuteReaderAsync (behavior As CommandBehavior) As Task(Of SqlDataReader)参数
- behavior
- CommandBehavior
语句执行和数据检索的选项。 当 设置为 时Default ， ReadAsync(CancellationToken) 在返回完整的任务之前读取整行。
返回
表示异步操作的任务。
例外
当 SqlDbType 设置为 Stream 时Value，使用了 Binary 或 VarBinary 以外的 。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
- 或 -
设置为 SqlDbType 时ValueTextReader ，使用了 Char、NChar、NVarChar、VarChar 或 Xml 以外的 。
-或-
无效的 CommandBehavior 值。
在完成任务前，为同一个实例多次调用 ExecuteReaderAsync(CommandBehavior)。
- 或 - SqlConnection 在流式处理操作期间关闭或删除。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
在流式处理操作期间， XmlReader 或 TextReader 对象中Stream发生错误。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
在 Stream 流式处理操作期间关闭了 、 XmlReader 或 TextReader 对象。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
注解
有关 .NET Framework Data Provider for SQL Server 中异步编程的详细信息，请参阅异步编程。
适用于
ExecuteReaderAsync(CancellationToken)
的 ExecuteReader() 异步版本，它将 发送到 CommandTextConnection 并生成 SqlDataReader 。
取消标记可用于在命令超时超过前请求放弃操作。 将通过返回的任务对象报告异常。
public:
System::Threading::Tasks::Task<Microsoft::Data::SqlClient::SqlDataReader ^> ^ ExecuteReaderAsync(System::Threading::CancellationToken cancellationToken);public System.Threading.Tasks.Task<Microsoft.Data.SqlClient.SqlDataReader> ExecuteReaderAsync (System.Threading.CancellationToken cancellationToken);override this.ExecuteReaderAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Data.SqlClient.SqlDataReader>Public Function ExecuteReaderAsync (cancellationToken As CancellationToken) As Task(Of SqlDataReader)参数
- cancellationToken
- CancellationToken
取消指示。
返回
表示异步操作的任务。
例外
当 SqlDbType 设置为 Stream 时Value，使用了 Binary 或 VarBinary 以外的 。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
- 或 -
设置为 SqlDbType 时ValueTextReader ，使用了 Char、NChar、NVarChar、VarChar 或 Xml 以外的 。
-或-
无效的 CommandBehavior 值。
在完成任务前，为同一个实例多次调用 ExecuteReaderAsync(CommandBehavior, CancellationToken)。
- 或 -
流式处理操作期间关闭或删除了 SqlConnection。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
在流式处理操作期间， XmlReader 或 TextReader 对象中Stream发生错误。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
在 Stream 流式处理操作期间关闭了 、 XmlReader 或 TextReader 对象。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
注解
有关 .NET Framework Data Provider for SQL Server 中异步编程的详细信息，请参阅异步编程。
适用于
ExecuteReaderAsync(CommandBehavior, CancellationToken)
的 ExecuteReader(CommandBehavior) 异步版本，它将 发送到 CommandTextConnection ，并生成一个 SqlDataReader 取消令牌可用于请求在命令超时之前放弃操作。 将通过返回的任务对象报告异常。
public:
System::Threading::Tasks::Task<Microsoft::Data::SqlClient::SqlDataReader ^> ^ ExecuteReaderAsync(System::Data::CommandBehavior behavior, System::Threading::CancellationToken cancellationToken);public System.Threading.Tasks.Task<Microsoft.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<Microsoft.Data.SqlClient.SqlDataReader>Public Function ExecuteReaderAsync (behavior As CommandBehavior, cancellationToken As CancellationToken) As Task(Of SqlDataReader)参数
- behavior
- CommandBehavior
语句执行和数据检索的选项。 当 设置为 时Default ， ReadAsync(CancellationToken) 在返回完整的任务之前读取整行。
- cancellationToken
- CancellationToken
取消指示。
返回
表示异步操作的任务。
例外
当 SqlDbType 设置为 Stream 时Value，使用了 Binary 或 VarBinary 以外的 。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
- 或 -
设置为 SqlDbType 时ValueTextReader ，使用了 Char、NChar、NVarChar、VarChar 或 Xml 以外的 。
-或-
无效的 CommandBehavior 值。
在完成任务前，为同一个实例多次调用 ExecuteReaderAsync(CommandBehavior, CancellationToken)。
- 或 -
流式处理操作期间关闭或删除了 SqlConnection。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
在流式处理操作期间， XmlReader 或 TextReader 对象中Stream发生错误。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
在 Stream 流式处理操作期间关闭了 、 XmlReader 或 TextReader 对象。 有关流式处理的详细信息，请参阅 SqlClient 流支持。
注解
有关 .NET Framework Data Provider for SQL Server 中异步编程的详细信息，请参阅异步编程。