SqlCommand.BeginExecuteXmlReader SqlCommand.BeginExecuteXmlReader SqlCommand.BeginExecuteXmlReader SqlCommand.BeginExecuteXmlReader Method

定義

この SqlCommand によって定義された Transact-SQL ステートメントまたはストアド プロシージャの非同期実行を開始し、結果を XmlReader オブジェクトとして返します。Initiates the asynchronous execution of the Transact-SQL statement or stored procedure that is described by this SqlCommand and returns results as an XmlReader object.

オーバーロード

BeginExecuteXmlReader() BeginExecuteXmlReader() BeginExecuteXmlReader() BeginExecuteXmlReader()

この SqlCommand によって定義された Transact-SQL ステートメントまたはストアド プロシージャの非同期実行を開始し、結果を XmlReader オブジェクトとして返します。Initiates the asynchronous execution of the Transact-SQL statement or stored procedure that is described by this SqlCommand and returns results as an XmlReader object.

BeginExecuteXmlReader(AsyncCallback, Object) BeginExecuteXmlReader(AsyncCallback, Object) BeginExecuteXmlReader(AsyncCallback, Object) BeginExecuteXmlReader(AsyncCallback, Object)

この SqlCommand によって定義された Transact-SQL ステートメントまたはストアド プロシージャの非同期実行を開始し、コールバック プロシージャを使用して結果を XmlReader オブジェクトとして返します。Initiates the asynchronous execution of the Transact-SQL statement or stored procedure that is described by this SqlCommand and returns results as an XmlReader object, using a callback procedure.

BeginExecuteXmlReader() BeginExecuteXmlReader() BeginExecuteXmlReader() BeginExecuteXmlReader()

この SqlCommand によって定義された Transact-SQL ステートメントまたはストアド プロシージャの非同期実行を開始し、結果を XmlReader オブジェクトとして返します。Initiates the asynchronous execution of the Transact-SQL statement or stored procedure that is described by this SqlCommand and returns results as an XmlReader object.

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

戻り値

結果のポーリング、待機、またはその両方に使用する IAsyncResult。この値は、単一の XML 値を取得する EndExecuteXmlReader を呼び出す場合にも必要となります。An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteXmlReader, which returns a single XML value.

例外

ValueStream に設定されたときに、Binary でも VarBinary でもない SqlDbType が使用されました。A SqlDbType other than Binary or VarBinary was used when Value was set to Stream. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

- または --or-

ValueTextReader に設定されたときに、CharNCharNVarCharVarCharXml のいずれでもない SqlDbType が使用されました。A SqlDbType other than Char, NChar, NVarChar, VarChar, or Xml was used when Value was set to TextReader.

- または --or-

ValueXmlReader に設定されたときに、Xml 以外の SqlDbType が使用されました。A SqlDbType other than Xml was used when Value was set to XmlReader.

コマンド テキストの実行中に発生したエラー。Any error that occurred while executing the command text.

- または --or-

ストリーミング操作中にタイムアウトが発生しました。A timeout occurred during a streaming operation. ストリーミングの詳細については、 「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

名前と値のペア "Asynchronous Processing=true" が、この SqlCommand の接続を定義する接続文字列に含まれていませんでした。The name/value pair "Asynchronous Processing=true" was not included within the connection string defining the connection for this SqlCommand.

- または --or-

ストリーミング操作中に、SqlConnection が閉じられたか切断されました。The SqlConnection closed or dropped during a streaming operation. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

ストリーミング操作中に、StreamXmlReader、または TextReader オブジェクトでエラーが発生しました。An error occurred in a Stream, XmlReader or TextReader object during a streaming operation. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

ストリーミング操作中に、StreamXmlReader、または TextReader オブジェクトが閉じられました。The Stream, XmlReader or TextReader object was closed during a streaming operation. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

次のコンソールアプリケーションでは、XML データを非同期に取得するプロセスを開始します。The following console application starts the process of retrieving XML data asynchronously. 結果を待機している間、この単純なアプリケーションはループ内にIsCompletedあり、プロパティ値を調査しています。While waiting for the results, this simple application sits in a loop, investigating the IsCompleted property value. プロセスが完了すると、コードは XML を取得し、その内容を表示します。Once the process has completed, the code retrieves the XML and displays its contents.

using System.Data.SqlClient;
using System.Xml;

class Class1
{
    static void Main()
    {
        // This example is not terribly effective, but it proves a point.
        // The WAITFOR statement simply adds enough time to prove the 
        // asynchronous nature of the command.
        string commandText =
            "WAITFOR DELAY '00:00:03';" +
            "SELECT Name, ListPrice FROM Production.Product " +
            "WHERE ListPrice < 100 " +
            "FOR XML AUTO, XMLDATA";

        RunCommandAsynchronously(commandText, GetConnectionString());

        Console.WriteLine("Press ENTER to continue.");
        Console.ReadLine();
    }

    private static void RunCommandAsynchronously(
        string commandText, string connectionString)
    {
        // Given command text and connection string, asynchronously execute
        // the specified command against the connection. For this example,
        // the code displays an indicator as it is working, verifying the 
        // asynchronous behavior. 
        using (SqlConnection connection = new SqlConnection(connectionString))
        {
            SqlCommand command = new SqlCommand(commandText, connection);

            connection.Open();
            IAsyncResult result = command.BeginExecuteXmlReader();

            // Although it is not necessary, the following procedure
            // displays a counter in the console window, indicating that 
            // the main thread is not blocked while awaiting the command 
            // results.
            int count = 0;
            while (!result.IsCompleted)
            {
                Console.WriteLine("Waiting ({0})", count++);
                // Wait for 1/10 second, so the counter
                // does not consume all available resources 
                // on the main thread.
                System.Threading.Thread.Sleep(100);
            }

            XmlReader reader = command.EndExecuteXmlReader(result);
            DisplayProductInfo(reader);
        }
    }

    private static 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")
            {
                Console.WriteLine("{0}: {1:C}",
                    reader["Name"], Convert.ToSingle(reader["ListPrice"]));
            }
        }
    }

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

        // If you have not included "Asynchronous Processing=true" in the
        // connection string, the command is not able
        // to execute asynchronously.
        return "Data Source=(local);Integrated Security=true;" +
            "Initial Catalog=AdventureWorks; Asynchronous Processing=true";
    }
}
Imports System.Data.SqlClient
Imports System.Xml

Module Module1

    Sub Main()
        ' This example is not terribly effective, but it proves a point.
        ' The WAITFOR statement simply adds enough time to prove the 
        ' asynchronous nature of the command.
        Dim commandText As String = _
         "WAITFOR DELAY '00:00:03';" & _
         "SELECT Name, ListPrice FROM Production.Product " & _
         "WHERE ListPrice < 100 " & _
         "FOR XML AUTO, XMLDATA"

        RunCommandAsynchronously(commandText, GetConnectionString())

        Console.WriteLine("Press ENTER to continue.")
        Console.ReadLine()
    End Sub

    Private Sub RunCommandAsynchronously( _
     ByVal commandText As String, ByVal connectionString As String)

        ' Given command text and connection string, asynchronously execute
        ' the specified command against the connection. For this example,
        ' the code displays an indicator as it is working, verifying the 
        ' asynchronous behavior. 
        Using connection As New SqlConnection(connectionString)
            Try
                Dim command As New SqlCommand(commandText, connection)
                connection.Open()
                Dim result As IAsyncResult = command.BeginExecuteXmlReader()

                ' Although it is not necessary, the following procedure
                ' displays a counter in the console window, indicating that 
                ' the main thread is not blocked while awaiting the command 
                ' results.
                Dim count As Integer = 0
                While Not result.IsCompleted
                    count += 1
                    Console.WriteLine("Waiting ({0})", count)
                    ' Wait for 1/10 second, so the counter
                    ' does not consume all available resources 
                    ' on the main thread.
                    Threading.Thread.Sleep(100)
                End While

                Using reader As XmlReader = command.EndExecuteXmlReader(result)
                    DisplayProductInfo(reader)
                End Using
            Catch ex As SqlException
                Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message)
            Catch ex As InvalidOperationException
                Console.WriteLine("Error: {0}", ex.Message)
            Catch ex As Exception
                ' You might want to pass these errors
                ' back out to the caller.
                Console.WriteLine("Error: {0}", ex.Message)
            End Try
        End Using
    End Sub

    Private Sub DisplayProductInfo(ByVal reader As XmlReader)
        ' 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" Then
                Console.WriteLine("{0}: {1:C}", _
                 reader("Name"), CSng(reader("ListPrice")))
            End If
        End While
    End Sub

    Private Function GetConnectionString() As String
        ' To avoid storing the connection string in your code,            
        ' you can retrieve it from a configuration file. 

        ' If you have not included "Asynchronous Processing=true" in the
        ' connection string, the command is not able
        ' to execute asynchronously.
        Return "Data Source=(local);Integrated Security=true;" & _
          "Initial Catalog=AdventureWorks; Asynchronous Processing=true"
    End Function
End Module

注釈

メソッドBeginExecuteXmlReaderは、行を XML として返す transact-sql ステートメントを非同期で実行するプロセスを開始します。これにより、ステートメントの実行中に他のタスクを同時に実行できるようになります。The BeginExecuteXmlReader method starts the process of asynchronously executing a Transact-SQL statement that returns rows as XML, so that other tasks can run concurrently while the statement is executing. ステートメントが完了したら、開発者はEndExecuteXmlReaderメソッドを呼び出して、操作を終了し、コマンドによって返された XML を取得する必要があります。When the statement has completed, developers must call the EndExecuteXmlReader method to finish the operation and retrieve the XML returned by the command. メソッドBeginExecuteXmlReaderは直ちにを返しますが、コードがEndExecuteXmlReader対応するメソッド呼び出しを実行するまで、同じSqlCommandオブジェクトに対して同期または非同期実行を開始する他の呼び出しを実行することはできません。The BeginExecuteXmlReader method returns immediately, but until the code executes the corresponding EndExecuteXmlReader method call, it must not execute any other calls that start a synchronous or asynchronous execution against the same SqlCommand object. コマンドのEndExecuteXmlReader実行が完了する前にを呼び出すSqlCommandと、オブジェクトは実行が完了するまでブロックされます。Calling the EndExecuteXmlReader before the command's execution is completed causes the SqlCommand object to block until the execution is finished.

プロパティCommandTextは、通常、有効な FOR XML 句を含む transact-sql ステートメントを指定します。The CommandText property ordinarily specifies a Transact-SQL statement with a valid FOR XML clause. ただし、 CommandTextでは、有効な XML をntext含むデータを返すステートメントを指定することもできます。However, CommandText can also specify a statement that returns ntext data that contains valid XML.

一般的BeginExecuteXmlReaderなクエリは、次C#の例のように書式設定できます。A typical BeginExecuteXmlReader query can be formatted as in the following C# example:

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

このメソッドを使用して、単一行、単一列の結果セットを取得することもできます。This method can also be used to retrieve a single-row, single-column result set. この場合、複数の行が返されると、メソッドはEndExecuteXmlReaderを最初のXmlReader行の値にアタッチし、残りの結果セットを破棄します。In this case, if more than one row is returned, the EndExecuteXmlReader method attaches the XmlReader to the value on the first row, and discards the rest of the result set.

複数のアクティブな結果セット (MARS) 機能により、複数のアクションで同じ接続を使用できます。The multiple active result set (MARS) feature lets multiple actions use the same connection.

コマンドテキストとパラメーターはサーバーに同期的に送信されることに注意してください。Note that the command text and parameters are sent to the server synchronously. 大きなコマンドまたは多数のパラメーターが送信された場合、このメソッドは書き込み中にブロックする可能性があります。If a large command or many parameters are sent, this method may block during writes. コマンドが送信された後、メソッドは、サーバーからの応答を待たずにすぐに制御を戻します。つまり、読み取りは非同期です。After the command is sent, the method returns immediately without waiting for an answer from the server--that is, reads are asynchronous. コマンドの実行は非同期ですが、値のフェッチはまだ同期されています。Although command execution is asynchronous, value fetching is still synchronous.

このオーバーロードではコールバックプロシージャがサポートされないため、開発者は、 IsCompleted BeginExecuteXmlReaderメソッドによってIAsyncResult返されるのプロパティを使用して、コマンドが完了したかどうかを確認するか、完了を待機する必要があります。AsyncWaitHandle 返さIAsyncResultれたのプロパティを使用する1つ以上のコマンドの。Because this overload does not support a callback procedure, developers need to either poll to determine whether the command has completed, using the IsCompleted property of the IAsyncResult returned by the BeginExecuteXmlReader method; or wait for the completion of one or more commands using the AsyncWaitHandle property of the returned IAsyncResult.

またはをExecuteReader使用BeginExecuteReaderして xml データにアクセスする場合、SQL Server は、2033文字を超える xml 結果をそれぞれ2033文字の複数行の長さで返します。If you use ExecuteReader or BeginExecuteReader to access XML data, SQL Server returns any XML results greater than 2,033 characters in length in multiple rows of 2,033 characters each. この動作を回避するにExecuteXmlReaderBeginExecuteXmlReader 、またはを使用して FOR XML クエリを読み取ります。To avoid this behavior, use ExecuteXmlReader or BeginExecuteXmlReader to read FOR XML queries.

こちらもご覧ください

BeginExecuteXmlReader(AsyncCallback, Object) BeginExecuteXmlReader(AsyncCallback, Object) BeginExecuteXmlReader(AsyncCallback, Object) BeginExecuteXmlReader(AsyncCallback, Object)

この SqlCommand によって定義された Transact-SQL ステートメントまたはストアド プロシージャの非同期実行を開始し、コールバック プロシージャを使用して結果を XmlReader オブジェクトとして返します。Initiates the asynchronous execution of the Transact-SQL statement or stored procedure that is described by this SqlCommand and returns results as an XmlReader object, using a callback procedure.

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 AsyncCallback AsyncCallback

コマンドの実行が完了したときに呼び出される AsyncCallback デリゲート。An AsyncCallback delegate that is invoked when the command's execution has completed. コールバックが不要である場合は、null (Microsoft Visual Basic の場合は Nothing) を渡します。Pass null (Nothing in Microsoft Visual Basic) to indicate that no callback is required.

stateObject
Object Object Object Object

コールバック プロシージャに渡されるユーザー定義の状態オブジェクト。A user-defined state object that is passed to the callback procedure. このオブジェクトは、コールバック プロシージャ内から、AsyncState プロパティを使用して取得します。Retrieve this object from within the callback procedure using the AsyncState property.

戻り値

結果のポーリング、待機、またはその両方に使用する IAsyncResult。この値は、コマンドの結果を XML として返す EndExecuteXmlReader(IAsyncResult) を呼び出す場合にも必要となります。An IAsyncResult that can be used to poll, wait for results, or both; this value is also needed when the EndExecuteXmlReader(IAsyncResult) is called, which returns the results of the command as XML.

例外

ValueStream に設定されたときに、Binary でも VarBinary でもない SqlDbType が使用されました。A SqlDbType other than Binary or VarBinary was used when Value was set to Stream. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

または-or-

ValueTextReader に設定されたときに、CharNCharNVarCharVarCharXml のいずれでもない SqlDbType が使用されました。A SqlDbType other than Char, NChar, NVarChar, VarChar, or Xml was used when Value was set to TextReader.

- または --or-

ValueXmlReader に設定されたときに、Xml 以外の SqlDbType が使用されました。A SqlDbType other than Xml was used when Value was set to XmlReader.

コマンド テキストの実行中に発生したエラー。Any error that occurred while executing the command text.

または-or-

ストリーミング操作中にタイムアウトが発生しました。A timeout occurred during a streaming operation. ストリーミングの詳細については、 「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

名前と値のペア "Asynchronous Processing=true" が、この SqlCommand の接続を定義する接続文字列に含まれていませんでした。The name/value pair "Asynchronous Processing=true" was not included within the connection string defining the connection for this SqlCommand.

- または --or-

ストリーミング操作中に、SqlConnection が閉じられたか切断されました。The SqlConnection closed or dropped during a streaming operation. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

ストリーミング操作中に、StreamXmlReader、または TextReader オブジェクトでエラーが発生しました。An error occurred in a Stream, XmlReader or TextReader object during a streaming operation. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

ストリーミング操作中に、StreamXmlReader、または TextReader オブジェクトが閉じられました。The Stream, XmlReader or TextReader object was closed during a streaming operation. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

次の Windows アプリケーションは、BeginExecuteXmlReader メソッドを使って、数秒の遅れを伴う (時間のかかるコマンドをエミュレートする) Transact-SQL ステートメントを実行する例を示しています。The following Windows application demonstrates the use of the BeginExecuteXmlReader method, executing a Transact-SQL statement that includes a delay of a few seconds (emulating a long-running command). この例では、 SqlCommand実行中のstateObjectオブジェクトをパラメーターとして渡します。これにSqlCommandより、コールバックプロシージャ内からオブジェクトを簡単に取得できるようEndExecuteXmlReaderになります。これにより、コードは、へのBeginExecuteXmlReader最初の呼び出し。This example passes the executing SqlCommand object as the stateObject parameter--doing so makes it simple to retrieve the SqlCommand object from within the callback procedure, so that the code can call the EndExecuteXmlReader method corresponding to the initial call to BeginExecuteXmlReader.

この例では、多くの重要な手法を示します。This example demonstrates many important techniques. これには、別のスレッドからフォームと対話するメソッドの呼び出しが含まれます。This includes calling a method that interacts with the form from a separate thread. また、この例では、ユーザーがコマンドを同時に複数回実行できないようにする方法と、コールバックプロシージャが呼び出される前にフォームが終了しないようにする方法について説明します。In addition, this example demonstrates how you must block users from executing a command multiple times concurrently, and how you must make sure that the form does not close before the callback procedure is called.

この例をセットアップするには、新しい Windows アプリケーションを作成します。To set up this example, create a new Windows application. コントロール、コントロール、およびLabelコントロールをフォームに配置します (各コントロールの既定の名前を受け入れます)。 ListBox ButtonPut a Button control, a ListBox control, and a Label control on the form (accepting the default name for each control). 次のコードをフォームのクラスに追加し、環境に合わせて必要に応じて接続文字列を変更します。Add the following code to the form's class, modifying the connection string as needed for your environment.

using System.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. 

            // If you do not include the Asynchronous Processing=true name/value pair,
            // you wo not be able to execute the command asynchronously.
            return "Data Source=(local);Integrated Security=true;" +
            "Initial Catalog=AdventureWorks; Asynchronous Processing=true";
        }

        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);
        }
    }
}
Imports System.Data.SqlClient
Imports System.Xml

Public Class Form1
    ' 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 Sub DisplayInfoDelegate(ByVal Text As String)
    Private Delegate Sub DisplayReaderDelegate(ByVal reader As XmlReader)

    Private isExecuting As Boolean

    ' This example maintains the connection object 
    ' externally, so that it is available for closing.
    Private connection As SqlConnection

    Private Function GetConnectionString() As String
        ' To avoid storing the connection string in your code,            
        ' you can retrieve it from a configuration file. 

        ' If you have not included "Asynchronous Processing=true" in the
        ' connection string, the command is not able
        ' to execute asynchronously.
        Return "Data Source=(local);Integrated Security=true;" & _
          "Initial Catalog=AdventureWorks; Asynchronous Processing=true"
    End Function

    Private Sub DisplayStatus(ByVal Text As String)
        Me.Label1.Text = Text
    End Sub

    Private Sub ClearProductInfo()
        ' Clear the list box.
        Me.ListBox1.Items.Clear()
    End Sub

    Private Sub DisplayProductInfo(ByVal reader As XmlReader)
        ' 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" Then
                Me.ListBox1.Items.Add(String.Format("{0}: {1:C}", _
                    reader("Name"), CSng(reader("ListPrice"))))
            End If
        End While
        DisplayStatus("Ready")
    End Sub

    Private Sub Form1_FormClosing(ByVal sender As Object, _
        ByVal e As System.Windows.Forms.FormClosingEventArgs) Handles Me.FormClosing
        If isExecuting Then
            MessageBox.Show(Me, "Cannot close the form until " & _
                "the pending asynchronous command has completed. Please wait...")
            e.Cancel = True
        End If
    End Sub

    Private Sub Button1_Click(ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button1.Click
        If isExecuting Then
            MessageBox.Show(Me, "Already executing. Please wait until the current query " & _
                "has completed.")
        Else
            Dim command As SqlCommand
            Try
                ClearProductInfo()
                DisplayStatus("Connecting...")
                connection = New SqlConnection(GetConnectionString())
                ' To emulate a long-running query, wait for 
                ' a few seconds before working with the data.
                Dim commandText As String = _
                    "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.
                Dim callback As New AsyncCallback(AddressOf HandleCallback)
                command.BeginExecuteXmlReader(callback, command)

            Catch ex As Exception
                isExecuting = False
                DisplayStatus(String.Format("Ready (last error: {0})", ex.Message))
                If connection IsNot Nothing Then
                    connection.Close()
                End If
            End Try
        End If
    End Sub

    Private Sub HandleCallback(ByVal result As IAsyncResult)
        Try
            ' Retrieve the original command object, passed
            ' to this procedure in the AsyncState property
            ' of the IAsyncResult parameter.
            Dim command As SqlCommand = CType(result.AsyncState, SqlCommand)
            Dim reader As XmlReader = 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. 
            Dim del As New DisplayReaderDelegate(AddressOf DisplayProductInfo)
            Me.Invoke(del, reader)

        Catch ex As Exception
            ' 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:
            Me.Invoke(New DisplayInfoDelegate(AddressOf DisplayStatus), _
                String.Format("Ready(last error: {0}", ex.Message))
        Finally
            isExecuting = False
            If connection IsNot Nothing Then
                connection.Close()
            End If
        End Try
    End Sub
End Class

注釈

メソッドBeginExecuteXmlReaderは、行を XML として返す transact-sql ステートメントまたはストアドプロシージャを非同期に実行するプロセスを開始します。これにより、ステートメントの実行中に他のタスクを同時に実行できるようになります。The BeginExecuteXmlReader method starts the process of asynchronously executing a Transact-SQL statement or stored procedure that returns rows as XML, so that other tasks can run concurrently while the statement is executing. ステートメントが完了したら、開発者はEndExecuteXmlReaderメソッドを呼び出して、操作を完了し、要求された XML データを取得する必要があります。When the statement has completed, developers must call the EndExecuteXmlReader method to finish the operation and retrieve the requested XML data. メソッドBeginExecuteXmlReaderは直ちにを返しますが、コードがEndExecuteXmlReader対応するメソッド呼び出しを実行するまで、同じSqlCommandオブジェクトに対して同期または非同期実行を開始する他の呼び出しを実行することはできません。The BeginExecuteXmlReader method returns immediately, but until the code executes the corresponding EndExecuteXmlReader method call, it must not execute any other calls that start a synchronous or asynchronous execution against the same SqlCommand object. コマンドのEndExecuteXmlReader実行が完了する前にを呼び出すSqlCommandと、オブジェクトは実行が完了するまでブロックされます。Calling the EndExecuteXmlReader before the command's execution is completed causes the SqlCommand object to block until the execution is finished.

プロパティCommandTextは、通常、有効な FOR XML 句を含む transact-sql ステートメントを指定します。The CommandText property ordinarily specifies a Transact-SQL statement with a valid FOR XML clause. ただし、 CommandTextでは、有効な XML を含むデータを返すステートメントを指定することもできます。However, CommandText can also specify a statement that returns data that contains valid XML. このメソッドを使用して、単一行、単一列の結果セットを取得することもできます。This method can also be used to retrieve a single-row, single-column result set. この場合、複数の行が返されると、メソッドはEndExecuteXmlReaderを最初のXmlReader行の値にアタッチし、残りの結果セットを破棄します。In this case, if more than one row is returned, the EndExecuteXmlReader method attaches the XmlReader to the value on the first row, and discards the rest of the result set.

一般的BeginExecuteXmlReaderなクエリは、次C#の例のように書式設定できます。A typical BeginExecuteXmlReader query can be formatted as in the following C# example:

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

このメソッドを使用して、単一行、単一列の結果セットを取得することもできます。This method can also be used to retrieve a single-row, single-column result set. この場合、複数の行が返されると、メソッドはEndExecuteXmlReaderを最初のXmlReader行の値にアタッチし、残りの結果セットを破棄します。In this case, if more than one row is returned, the EndExecuteXmlReader method attaches the XmlReader to the value on the first row, and discards the rest of the result set.

複数のアクティブな結果セット (MARS) 機能により、複数のアクションで同じ接続を使用できます。The multiple active result set (MARS) feature lets multiple actions use the same connection.

パラメーター callbackを使用すると、 AsyncCallbackステートメントが完了したときに呼び出されるデリゲートを指定できます。The callback parameter lets you specify an AsyncCallback delegate that is called when the statement has completed. このデリゲートプロシージャ内EndExecuteXmlReaderから、またはアプリケーション内の他の任意の場所からメソッドを呼び出すことができます。You can call the EndExecuteXmlReader method from within this delegate procedure, or from any other location within your application. また、 stateObjectパラメーターに任意のオブジェクトを渡すことができ、コールバックプロシージャはAsyncStateプロパティを使用してこの情報を取得できます。In addition, you can pass any object in the stateObject parameter, and your callback procedure can retrieve this information using the AsyncState property.

コマンドテキストとパラメーターはサーバーに同期的に送信されることに注意してください。Note that the command text and parameters are sent to the server synchronously. 大きなコマンドまたは多数のパラメーターが送信された場合、このメソッドは書き込み中にブロックする可能性があります。If a large command or many parameters is sent, this method may block during writes. コマンドが送信された後、メソッドは、サーバーからの応答を待たずにすぐに制御を戻します。つまり、読み取りは非同期です。After the command is sent, the method returns immediately without waiting for an answer from the server--that is, reads are asynchronous.

操作の実行中に発生したすべてのエラーは、コールバックプロシージャで例外としてスローされます。All errors that occur during the execution of the operation are thrown as exceptions in the callback procedure. この例外は、メインアプリケーションではなく、コールバックプロシージャで処理する必要があります。You must handle the exception in the callback procedure, not in the main application. コールバックプロシージャでの例外処理の詳細については、このトピックの例を参照してください。See the example in this topic for additional information on handling exceptions in the callback procedure.

またはExecuteReader BeginExecuteReaderを使用して xml データにアクセスする場合、SQL Server は2033文字を超える xml 結果をそれぞれ2033文字の複数行の長さで返します。If you use ExecuteReader or BeginExecuteReader to access XML data, SQL Server will return any XML results greater than 2,033 characters in length in multiple rows of 2,033 characters each. この動作を回避するにExecuteXmlReaderBeginExecuteXmlReader 、またはを使用して FOR XML クエリを読み取ります。To avoid this behavior, use ExecuteXmlReader or BeginExecuteXmlReader to read FOR XML queries.

こちらもご覧ください

適用対象