共用方式為


SqlCommand.BeginExecuteXmlReader 方法

定義

多載

BeginExecuteXmlReader()

啟始這個 SqlCommand 所描述之 Transact-SQL 陳述式或預存程序的非同步執行,並傳回結果做為 XmlReader 物件。

BeginExecuteXmlReader(AsyncCallback, Object)

使用回呼程序,啟始這個 SqlCommand 所描述之 Transact-SQL 陳述式或預存程序的非同步執行,並傳回結果做為 XmlReader 物件。

BeginExecuteXmlReader()

啟始這個 SqlCommand 所描述之 Transact-SQL 陳述式或預存程序的非同步執行,並傳回結果做為 XmlReader 物件。

public:
 IAsyncResult ^ BeginExecuteXmlReader();
public IAsyncResult BeginExecuteXmlReader ();
member this.BeginExecuteXmlReader : unit -> IAsyncResult
Public Function BeginExecuteXmlReader () As IAsyncResult

傳回

IAsyncResult,可用來輪詢或等候結果,或兩者;叫用時也需要這個值EndExecuteXmlReader ,它會傳回單一 XML 值。

例外狀況

SqlDbType當 設定 Stream 為 時 Value ,使用了BinaryVarBinary以外的 。 如需串流的詳細資訊,請參閱 SqlClient 串流支援

-或-

SqlDbType當 設定 TextReader 為 時 Value ,會使用CharNCharNVarCharVarCharXml以外的 。

-或-

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

執行命令文字時發生的任何錯誤。

-或-

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

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

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

在串流作業期間, XmlReaderTextReader 物件中 Stream 發生錯誤。 如需串流的詳細資訊,請參閱 SqlClient 串流支援

XmlReaderStream 串流作業期間,或 TextReader 物件已關閉。 如需串流的詳細資訊,請參閱 SqlClient 串流支援

範例

下列主控台應用程式會啟動非同步擷取 XML 資料的程式。 等候結果時,這個簡單的應用程式會位於迴圈中,並 IsCompleted 調查屬性值。 程式完成後,程式碼會擷取 XML 並顯示其內容。

[!code-csharp[SqlCommand_BeginExecuteXmlReader#1] ( (~/.。/sqlclient/doc/samples/SqlCommand_BeginExecuteXmlReader.cs) ]

備註

方法 BeginExecuteXmlReader 會啟動非同步執行 Transact-SQL 語句以 XML 傳回資料列的程式,讓其他工作可以在語句執行時同時執行。 當語句完成時,開發人員必須呼叫 EndExecuteXmlReader 方法來完成作業,並擷取命令傳回的 XML。 方法 BeginExecuteXmlReader 會立即傳回,但直到程式碼執行對應的 EndExecuteXmlReader 方法呼叫為止,它不得執行任何其他針對相同 SqlCommand 物件啟動同步或非同步執行的呼叫。 EndExecuteXmlReader在命令的執行完成之前呼叫 ,會導致 SqlCommand 物件封鎖直到執行完成為止。

屬性 CommandText 通常會指定具有有效 FOR XML 子句的 Transact-SQL 語句。 不過, CommandText 也可以指定語句來傳回 ntext 包含有效 XML 的資料。

一般 BeginExecuteXmlReader 查詢的格式可以如下列 C# 範例所示:

SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);

這個方法也可以用來擷取單一資料列的單一資料行結果集。 在此情況下,如果傳回多個資料列,方法會將 EndExecuteXmlReader 附加 XmlReader 至第一個資料列的值,並捨棄結果集的其餘部分。

MARS) 功能的多個作用中結果集 (可讓多個動作使用相同的連線。

請注意,命令文字和參數會同步傳送至伺服器。 如果傳送大型命令或許多參數,這個方法可能會在寫入期間封鎖。 傳送命令之後,方法會立即傳回,而不需要等候來自伺服器的答案,也就是讀取是非同步。 雖然命令執行是非同步,但值擷取仍是同步的。

因為這個多載不支援回呼程式,所以開發人員需要輪詢以判斷命令是否已完成,使用 IsCompleted 方法所 BeginExecuteXmlReader 傳回的 IAsyncResult 屬性;或使用傳回 IAsyncResult 的 屬性等候完成一或多個命令 AsyncWaitHandle

如果您使用 ExecuteReaderBeginExecuteReader 存取 XML 資料,SQL Server會以 2,033 個字元的多個資料列傳回任何大於 2,033 個字元的 XML 結果。 若要避免這種行為,請使用 ExecuteXmlReaderBeginExecuteXmlReader 來讀取 FOR XML 查詢。

這個方法會 CommandTimeout 忽略 屬性。

適用於

BeginExecuteXmlReader(AsyncCallback, Object)

使用回呼程序,啟始這個 SqlCommand 所描述之 Transact-SQL 陳述式或預存程序的非同步執行,並傳回結果做為 XmlReader 物件。

public:
 IAsyncResult ^ BeginExecuteXmlReader(AsyncCallback ^ callback, System::Object ^ stateObject);
public IAsyncResult BeginExecuteXmlReader (AsyncCallback callback, object stateObject);
member this.BeginExecuteXmlReader : AsyncCallback * obj -> IAsyncResult
Public Function BeginExecuteXmlReader (callback As AsyncCallback, stateObject As Object) As IAsyncResult

參數

callback
AsyncCallback

完成執行命令時叫用的 AsyncCallback 委派。 通過nullNothingmicrosoft Visual Basic) 中的 (,表示不需要回呼。

stateObject
Object

已傳遞至回呼程序的使用者定義狀態物件。 使用 AsyncState 屬性,從回呼程序內擷取這個物件。

傳回

IAsyncResult,可用於輪詢或等待結果 (或兩者);此外,呼叫會以 XML 傳回命令結果的 EndExecuteXmlReader(IAsyncResult) 時,也需要這個值。

例外狀況

SqlDbType當 設定 Stream 為 時 Value ,使用了BinaryVarBinary以外的 。 如需串流的詳細資訊,請參閱 SqlClient 串流支援

-或-

SqlDbType當 設定 TextReader 為 時 Value ,會使用CharNCharNVarCharVarCharXml以外的 。

-或-

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

執行命令文字時發生的任何錯誤。

-或-

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

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

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

在串流作業期間, XmlReaderTextReader 物件中 Stream 發生錯誤。 如需串流的詳細資訊,請參閱 SqlClient 串流支援

XmlReaderStream 串流作業期間,或 TextReader 物件已關閉。 如需串流的詳細資訊,請參閱 SqlClient 串流支援

範例

下列 Windows 應用程式示範如何使用 BeginExecuteXmlReader 方法,來執行包含數秒延遲的 Transact-SQL 陳述式 (模擬長時間執行的命令)。 這個範例會將執行 SqlCommand 中的 物件當做 stateObject 參數傳遞,如此即可輕鬆地從回呼程式內擷取 SqlCommand 物件,讓程式碼可以呼叫 EndExecuteXmlReader 對應至 初始呼叫 BeginExecuteXmlReader 的方法。

此範例示範許多重要的技術。 這包括呼叫從個別執行緒與表單互動的方法。 此外,此範例示範如何封鎖使用者多次同時執行命令,以及如何確保表單在呼叫回呼程式之前不會關閉。

若要設定此範例,請建立新的 Windows 應用程式。 Button將控制項、 ListBox 控制項和 Label 控制項放在表單上, (接受每個控制項的預設名稱) 。 將下列程式碼新增至表單的 類別,視您的環境需要修改連接字串。

// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Data.SqlClient;
using System.Xml;

namespace Microsoft.AdoDotNet.CodeSamples
{
    public partial class Form1 : Form
    {
        // Hook up the form's Load event handler and then add 
        // this code to the form's class:
        // You need these delegates in order to display text from a thread
        // other than the form's thread. See the HandleCallback
        // procedure for more information.
        private delegate void DisplayInfoDelegate(string Text);
        private delegate void DisplayReaderDelegate(XmlReader reader);

        private bool isExecuting;

        // This example maintains the connection object 
        // externally, so that it is available for closing.
        private SqlConnection connection;

        public Form1()
        {
            InitializeComponent();
        }

        private string GetConnectionString()
        {
            // To avoid storing the connection string in your code, 
            // you can retrieve it from a configuration file. 

            return "Data Source=(local);Integrated Security=true;" +
            "Initial Catalog=AdventureWorks";
        }

        private void DisplayStatus(string Text)
        {
            this.label1.Text = Text;
        }

        private void ClearProductInfo()
        {
            // Clear the list box.
            this.listBox1.Items.Clear();
        }

        private void DisplayProductInfo(XmlReader reader)
        {
            // Display the data within the reader.
            while (reader.Read())
            {
                // Skip past items that are not from the correct table.
                if (reader.LocalName.ToString() == "Production.Product")
                {
                    this.listBox1.Items.Add(String.Format("{0}: {1:C}",
                        reader["Name"], Convert.ToDecimal(reader["ListPrice"])));
                }
            }
            DisplayStatus("Ready");
        }

        private void Form1_FormClosing(object sender,
            System.Windows.Forms.FormClosingEventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this, "Cannot close the form until " +
                    "the pending asynchronous command has completed. Please wait...");
                e.Cancel = true;
            }
        }

        private void button1_Click(object sender, System.EventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this,
                    "Already executing. Please wait until the current query " +
                    "has completed.");
            }
            else
            {
                SqlCommand command = null;
                try
                {
                    ClearProductInfo();
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());

                    // To emulate a long-running query, wait for 
                    // a few seconds before working with the data.
                    string commandText =
                        "WAITFOR DELAY '00:00:03';" +
                        "SELECT Name, ListPrice FROM Production.Product " +
                        "WHERE ListPrice < 100 " +
                        "FOR XML AUTO, XMLDATA";

                    command = new SqlCommand(commandText, connection);
                    connection.Open();

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the 
                    // SqlCommand object as the second parameter in the 
                    // BeginExecuteXmlReader call, doing so makes it easier
                    // to call EndExecuteXmlReader in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteXmlReader(callback, command);

                }
                catch (Exception ex)
                {
                    isExecuting = false;
                    DisplayStatus(string.Format("Ready (last error: {0})", ex.Message));
                    if (connection != null)
                    {
                        connection.Close();
                    }
                }
            }
        }

        private void HandleCallback(IAsyncResult result)
        {
            try
            {
                // Retrieve the original command object, passed
                // to this procedure in the AsyncState property
                // of the IAsyncResult parameter.
                SqlCommand command = (SqlCommand)result.AsyncState;
                XmlReader reader = command.EndExecuteXmlReader(result);

                // You may not interact with the form and its contents
                // from a different thread, and this callback procedure
                // is all but guaranteed to be running from a different thread
                // than the form. 

                // Instead, you must call the procedure from the form's thread.
                // One simple way to accomplish this is to call the Invoke
                // method of the form, which calls the delegate you supply
                // from the form's thread. 
                DisplayReaderDelegate del = new DisplayReaderDelegate(DisplayProductInfo);
                this.Invoke(del, reader);

            }
            catch (Exception ex)
            {
                // Because you are now running code in a separate thread, 
                // if you do not handle the exception here, none of your other
                // code catches the exception. Because none of 
                // your code is on the call stack in this thread, there is nothing
                // higher up the stack to catch the exception if you do not 
                // handle it here. You can either log the exception or 
                // invoke a delegate (as in the non-error case in this 
                // example) to display the error on the form. In no case
                // can you simply display the error without executing a delegate
                // as in the try block here. 

                // You can create the delegate instance as you 
                // invoke it, like this:
                this.Invoke(new DisplayInfoDelegate(DisplayStatus),
                String.Format("Ready(last error: {0}", ex.Message));
            }
            finally
            {
                isExecuting = false;
                if (connection != null)
                {
                    connection.Close();
                }
            }
        }

        private void Form1_Load(object sender, System.EventArgs e)
        {
            this.button1.Click += new System.EventHandler(this.button1_Click);
            this.FormClosing += new System.Windows.Forms.
                FormClosingEventHandler(this.Form1_FormClosing);
        }
    }
}
// </Snippet1>

備註

方法 BeginExecuteXmlReader 會啟動非同步執行 Transact-SQL 語句或以 XML 傳回資料列的預存程式的程式,讓其他工作可以在語句執行時同時執行。 當語句完成時,開發人員必須呼叫 EndExecuteXmlReader 方法來完成作業,並擷取要求的 XML 資料。 方法 BeginExecuteXmlReader 會立即傳回,但直到程式碼執行對應的 EndExecuteXmlReader 方法呼叫為止,它不得執行任何其他針對相同 SqlCommand 物件啟動同步或非同步執行的呼叫。 EndExecuteXmlReader在命令的執行完成之前呼叫 ,會導致 SqlCommand 物件封鎖直到執行完成為止。

屬性 CommandText 通常會指定具有有效 FOR XML 子句的 Transact-SQL 語句。 不過, CommandText 也可以指定語句來傳回包含有效 XML 的資料。 這個方法也可以用來擷取單一資料列的單一資料行結果集。 在此情況下,如果傳回多個資料列,方法會將 EndExecuteXmlReader 附加 XmlReader 至第一個資料列的值,並捨棄結果集的其餘部分。

一般 BeginExecuteXmlReader 查詢的格式可以如下列 C# 範例所示:

SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);

這個方法也可以用來擷取單一資料列的單一資料行結果集。 在此情況下,如果傳回多個資料列,方法會將 EndExecuteXmlReader 附加 XmlReader 至第一個資料列的值,並捨棄結果集的其餘部分。

MARS) 功能的多個作用中結果集 (可讓多個動作使用相同的連線。

參數 callback 可讓您指定 AsyncCallback 語句完成時所呼叫的委派。 您可以從這個委派程式或應用程式內的任何其他位置呼叫 EndExecuteXmlReader 方法。 此外,您可以在 參數中 stateObject 傳遞任何物件,而回呼程式可以使用 屬性擷取這項資訊 AsyncState

請注意,命令文字和參數會同步傳送至伺服器。 如果傳送大型命令或許多參數,這個方法可能會在寫入期間封鎖。 傳送命令之後,方法會立即傳回,而不需要等候來自伺服器的答案,也就是讀取是非同步。

在作業執行期間發生的所有錯誤都會在回呼程式中擲回為例外狀況。 您必須在回呼程式中處理例外狀況,而不是在主應用程式中。 如需在回呼程式中處理例外狀況的其他資訊,請參閱本主題中的範例。

如果您使用 ExecuteReaderBeginExecuteReader 存取 XML 資料,SQL Server會傳回長度大於 2,033 個字元的任何 XML 結果,每個資料列各 2,033 個字元。 若要避免這種行為,請使用 ExecuteXmlReaderBeginExecuteXmlReader 來讀取 FOR XML 查詢。

這個方法會 CommandTimeout 忽略 屬性。

另請參閱

適用於