SqlCommand.ExecuteReaderAsync 方法

定義

命名空間:

System.Data.SqlClient

組件:

System.Data.SqlClient.dll

套件:

System.Data.SqlClient v4.8.6

起始這個 SqlCommand 所描述之 Transact-SQL 陳述式或預存程序的非同步執行。

多載

ExecuteReaderAsync()	非同步版本的 ExecuteReader()，這個版本會將 CommandText 傳送至 Connection，並建置 SqlDataReader。 例外狀況將經由傳回的 Task 物件回報。
ExecuteReaderAsync(CommandBehavior)	非同步版本的 ExecuteReader(CommandBehavior)，這個版本會將 CommandText 傳送至 Connection，並建置 SqlDataReader。 例外狀況將經由傳回的 Task 物件回報。
ExecuteReaderAsync(CancellationToken)	非同步版本的 ExecuteReader()，這個版本會將 CommandText 傳送至 Connection，並建置 SqlDataReader。 取消語彙基元可用於要求在命令逾時之前捨棄作業。 例外狀況將經由傳回的 Task 物件回報。
ExecuteReaderAsync(CommandBehavior, CancellationToken)	非同步版本的 ExecuteReader(CommandBehavior)，這個版本會將 CommandText 傳送至 Connection，並建置 SqlDataReader。 取消語彙基元可用於要求在命令逾時之前捨棄作業。 例外狀況將經由傳回的 Task 物件回報。

備註

如需 .NET Framework Data Provider for SQL Server 中非同步程式設計的詳細資訊，請參閱非同步程式設計。

ExecuteReaderAsync()

非同步版本的 ExecuteReader()，這個版本會將 CommandText 傳送至 Connection，並建置 SqlDataReader。 例外狀況將經由傳回的 Task 物件回報。

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 時，使用 Binary 或 VarBinary 以外的 SqlDbType。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

-或-

SqlDbType當 設定 TextReader 為 時 Value ，會使用Char、NChar、NVarChar、VarChar或Xml以外的 。

-或-

當 Value 設定為 XmlReader 時，使用 Xml 以外的 SqlDbType。

ArgumentException

無效的 CommandBehavior 值。

InvalidOperationException

在工作完成前，對同一個執行個體呼叫 ExecuteReaderAsync() 不止一次。

-或-

在串流作業期間已關閉或卸除的 SqlConnection。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

-或-

在連接字串中指定了 Context Connection=true。

SqlException

SQL Server 於執行命令文字時傳回錯誤。

-或-

串流作業期間發生逾時。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

IOException

Stream、XmlReader 或 TextReader 物件在串流作業期間發生錯誤。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

ObjectDisposedException

Stream、XmlReader 或 TextReader 物件在串流作業期間已關閉。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

備註

如需 .NET Framework Data Provider for SQL Server 中非同步程式設計的詳細資訊，請參閱非同步程式設計。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException 仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 ExecuteReader() 例外狀況。

另請參閱

• ADO.NET 概觀 \(部分機器翻譯\)

ExecuteReaderAsync(CommandBehavior)

非同步版本的 ExecuteReader(CommandBehavior)，這個版本會將 CommandText 傳送至 Connection，並建置 SqlDataReader。 例外狀況將經由傳回的 Task 物件回報。

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 時，使用 Binary 或 VarBinary 以外的 SqlDbType。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

-或-

SqlDbType當 設定 TextReader 為 時 Value ，會使用Char、NChar、NVarChar、VarChar或Xml以外的 。

-或-

當 Value 設定為 XmlReader 時，使用 Xml 以外的 SqlDbType。

ArgumentException

無效的 CommandBehavior 值。

InvalidOperationException

在工作完成前，對同一個執行個體呼叫 ExecuteReaderAsync(CommandBehavior) 不止一次。

-或-

在串流作業期間已關閉或卸除的 SqlConnection。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

-或-

在連接字串中指定了 Context Connection=true。

SqlException

SQL Server 於執行命令文字時傳回錯誤。

-或-

串流作業期間發生逾時。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

IOException

Stream、XmlReader 或 TextReader 物件在串流作業期間發生錯誤。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

ObjectDisposedException

Stream、XmlReader 或 TextReader 物件在串流作業期間已關閉。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

備註

如需 .NET Framework Data Provider for SQL Server 中非同步程式設計的詳細資訊，請參閱非同步程式設計。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException 仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 ExecuteReader(CommandBehavior) 例外狀況。

另請參閱

• ADO.NET 概觀 \(部分機器翻譯\)

ExecuteReaderAsync(CancellationToken)

非同步版本的 ExecuteReader()，這個版本會將 CommandText 傳送至 Connection，並建置 SqlDataReader。

取消語彙基元可用於要求在命令逾時之前捨棄作業。 例外狀況將經由傳回的 Task 物件回報。

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 時，使用 Binary 或 VarBinary 以外的 SqlDbType。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

-或-

SqlDbType當 設定 TextReader 為 時 Value ，會使用Char、NChar、NVarChar、VarChar或Xml以外的 。

-或-

當 Value 設定為 XmlReader 時，使用 Xml 以外的 SqlDbType。

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

解除標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

如需 .NET Framework Data Provider for SQL Server 中非同步程式設計的詳細資訊，請參閱非同步程式設計。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException 仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 ExecuteReader() 例外狀況。

另請參閱

• ADO.NET 概觀 \(部分機器翻譯\)

ExecuteReaderAsync(CommandBehavior, CancellationToken)

非同步版本的 ExecuteReader(CommandBehavior)，這個版本會將 CommandText 傳送至 Connection，並建置 SqlDataReader。

取消語彙基元可用於要求在命令逾時之前捨棄作業。 例外狀況將經由傳回的 Task 物件回報。

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 時，使用 Binary 或 VarBinary 以外的 SqlDbType。 如需串流的詳細資訊，請參閱 SqlClient 串流支援。

-或-

SqlDbType當 設定 TextReader 為 時 Value ，會使用Char、NChar、NVarChar、VarChar或Xml以外的 。

-或-

當 Value 設定為 XmlReader 時，使用 Xml 以外的 SqlDbType。

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

解除標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

如需 .NET Framework Data Provider for SQL Server 中非同步程式設計的詳細資訊，請參閱非同步程式設計。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException 仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 ExecuteReader(CommandBehavior) 例外狀況。

另請參閱

• ADO.NET 概觀 \(部分機器翻譯\)