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

Definition

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und gibt die Ergebnisse in Form eines XmlReader-Objekts zurück.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.

Überlädt

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

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und gibt die Ergebnisse in Form eines XmlReader-Objekts zurück.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)

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und gibt mithilfe einer Rückrufprozedur die Ergebnisse in Form eines XmlReader-Objekts zurück.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()

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und gibt die Ergebnisse in Form eines XmlReader-Objekts zurück.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

Gibt zurück

Ein IAsyncResult, das zum Abfragen von Ergebnissen und/oder Warten auf Ergebnisse verwendet werden kann. Dieser Wert wird auch zum Aufrufen von EndExecuteXmlReader benötigt, der einen einzelnen XML-Wert zurückgibt.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.

Ausnahmen

Es wurde ein anderer SqlDbType als Binary oder VarBinary verwendet, als Value auf Stream festgelegt wurde.A SqlDbType other than Binary or VarBinary was used when Value was set to Stream. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).For more information about streaming, see SqlClient Streaming Support.

- oder --or-

Es wurde ein anderer SqlDbType als Char, NChar, NVarChar, VarChar oder Xml verwendet, als Value auf TextReader festgelegt wurde.A SqlDbType other than Char, NChar, NVarChar, VarChar, or Xml was used when Value was set to TextReader.

- oder --or-

Es wurde ein anderer SqlDbType als Xml verwendet, als Value auf XmlReader festgelegt wurde.A SqlDbType other than Xml was used when Value was set to XmlReader.

Alle Fehler, die beim Ausführen des Befehlstexts aufgetreten sind.Any error that occurred while executing the command text.

- oder --or-

Bei einem Streamingvorgang ist ein Timeout aufgetreten.A timeout occurred during a streaming operation. Weitere Informationen zum Streaming finden Sie unter SqlClient-Streamingunterstützung.For more information about streaming, see SqlClient Streaming Support.

Das Name-Wert-Paar "Asynchronous Processing=true" war nicht in der Verbindungszeichenfolge enthalten, mit der die Verbindung für diesen SqlCommand definiert wird.The name/value pair "Asynchronous Processing=true" was not included within the connection string defining the connection for this SqlCommand.

- oder --or-

Die SqlConnection wurde während eines Streamingvorgangs geschlossen oder getrennt.The SqlConnection closed or dropped during a streaming operation. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).For more information about streaming, see SqlClient Streaming Support.

Während eines Streamingvorgangs ist bei einem Stream-, XmlReader- oder TextReader-Objekt ein Fehler aufgetreten.An error occurred in a Stream, XmlReader or TextReader object during a streaming operation. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).For more information about streaming, see SqlClient Streaming Support.

Das Stream-, XmlReader - oder TextReader -Objekt wurde während eines Streamingvorgangs geschlossen.The Stream, XmlReader or TextReader object was closed during a streaming operation. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).For more information about streaming, see SqlClient Streaming Support.

Beispiele

Die folgende Konsolenanwendung startet das asynchrone Abrufen von XML-Daten.The following console application starts the process of retrieving XML data asynchronously. Beim Warten auf die Ergebnisse befindet sich diese einfache Anwendung in einer Schleife, die den IsCompleted Eigenschafts Wert untersucht.While waiting for the results, this simple application sits in a loop, investigating the IsCompleted property value. Nachdem der Prozess abgeschlossen wurde, ruft der Code den XML-Code ab und zeigt seinen Inhalt an.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

Hinweise

Die BeginExecuteXmlReader -Methode startet die asynchrone Ausführung einer Transact-SQL-Anweisung, die Zeilen als XML zurückgibt, damit andere Tasks gleichzeitig ausgeführt werden können, während die Anweisung ausgeführt wird.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. Wenn die-Anweisung abgeschlossen ist, müssen Entwickler die EndExecuteXmlReader -Methode aufrufen, um den Vorgang abzuschließen und die vom Befehl zurückgegebene XML-Datei abzurufen.When the statement has completed, developers must call the EndExecuteXmlReader method to finish the operation and retrieve the XML returned by the command. Die BeginExecuteXmlReader Methode wird sofort zurückgegeben, aber bis der Code den EndExecuteXmlReader entsprechenden Methodenaufruf ausführt, dürfen keine anderen Aufrufe ausgeführt werden, die eine synchrone oder asynchrone Ausführung für SqlCommand dasselbe Objekt starten.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. Wenn aufgerufen wird, SqlCommand bevordieAusführungdesBefehlsabgeschlossenist,wirddas-Objektblockiert,bisdieAusführungabgeschlossenist.EndExecuteXmlReaderCalling the EndExecuteXmlReader before the command's execution is completed causes the SqlCommand object to block until the execution is finished.

Die CommandText -Eigenschaft gibt normalerweise eine Transact-SQL-Anweisung mit einer gültigen for XML-Klausel an.The CommandText property ordinarily specifies a Transact-SQL statement with a valid FOR XML clause. Kann jedoch auch eine-Anweisung angeben, die ntext Daten zurückgibt, die gültiges XML enthalten. CommandTextHowever, CommandText can also specify a statement that returns ntext data that contains valid XML.

Eine typische BeginExecuteXmlReader Abfrage kann wie im folgenden C# Beispiel formatiert werden: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);  

Diese Methode kann auch verwendet werden, um ein einzeiliges, einzeiliges Resultset abzurufen.This method can also be used to retrieve a single-row, single-column result set. Wenn in diesem Fall mehr als eine Zeile zurückgegeben wird, fügt EndExecuteXmlReader die-Methode XmlReader den an den Wert in der ersten Zeile an und verwirft den Rest des Resultsets.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.

Mit der Mars-Funktion (Multiple Active Result Set) können mehrere Aktionen dieselbe Verbindung verwenden.The multiple active result set (MARS) feature lets multiple actions use the same connection.

Beachten Sie, dass der Befehls Text und die Parameter synchron an den Server gesendet werden.Note that the command text and parameters are sent to the server synchronously. Wenn ein großer Befehl oder viele Parameter gesendet werden, kann diese Methode während Schreibvorgängen blockiert werden.If a large command or many parameters are sent, this method may block during writes. Nachdem der Befehl gesendet wurde, wird die Methode sofort zurückgegeben, ohne auf eine Antwort vom Server zu warten, d. h., die Lesevorgänge sind asynchron.After the command is sent, the method returns immediately without waiting for an answer from the server--that is, reads are asynchronous. Obwohl die Befehlsausführung asynchron ist, ist das Abrufen von Werten weiterhin synchron.Although command execution is asynchronous, value fetching is still synchronous.

Da diese Überladung keine Rückruf Prozedur unterstützt, müssen Entwickler entweder Abfragen, um zu bestimmen, ob der Befehl abgeschlossen wurde, IsCompleted indem Sie die IAsyncResult -Eigenschaft von BeginExecuteXmlReader verwenden, die von der-Methode zurückgegeben wurde, oder auf den Abschluss warten. von mindestens einem Befehl, der die AsyncWaitHandle -Eigenschaft des zurück IAsyncResultgegebenen-Objekts verwendet.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.

Wenn Sie oder ExecuteReader BeginExecuteReader verwenden, um auf XML-Daten zuzugreifen, gibt SQL Server alle XML-Ergebnisse mit einer Länge von mehr als 2.033 Zeichen in mehreren Zeilen mit jeweils 2.033 Zeichen zurück.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. Um dieses Verhalten zu vermeiden, ExecuteXmlReader verwenden BeginExecuteXmlReader Sie oder zum Lesen von for XML-Abfragen.To avoid this behavior, use ExecuteXmlReader or BeginExecuteXmlReader to read FOR XML queries.

Siehe auch

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

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und gibt mithilfe einer Rückrufprozedur die Ergebnisse in Form eines XmlReader-Objekts zurück.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

Parameter

callback
AsyncCallback AsyncCallback AsyncCallback AsyncCallback

Ein AsyncCallback-Delegat, der aufgerufen wird, wenn die Ausführung des Befehls abgeschlossen wurde.An AsyncCallback delegate that is invoked when the command's execution has completed. Übergeben Sie null (Nothing in Microsoft Visual Basic), um anzugeben, dass kein Rückruf erforderlich ist.Pass null (Nothing in Microsoft Visual Basic) to indicate that no callback is required.

stateObject
Object Object Object Object

Ein benutzerdefiniertes Zustandsobjekt, das an die Rückrufprozedur übergeben wird.A user-defined state object that is passed to the callback procedure. Rufen Sie dieses Objekt innerhalb der Rückrufprozedur mit der AsyncState-Eigenschaft ab.Retrieve this object from within the callback procedure using the AsyncState property.

Gibt zurück

Ein IAsyncResult, das zum Abfragen von Ergebnissen und/oder als Warteschleife verwendet werden kann. Dieser Wert wird auch benötigt, wenn EndExecuteXmlReader(IAsyncResult) aufgerufen wird, mit dem die Ergebnisse des Befehls im XML-Format zurückgegeben werden.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.

Ausnahmen

Es wurde ein anderer SqlDbType als Binary oder VarBinary verwendet, als Value auf Stream festgelegt wurde.A SqlDbType other than Binary or VarBinary was used when Value was set to Stream. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).For more information about streaming, see SqlClient Streaming Support.

- oder --or-

Es wurde ein anderer SqlDbType als Char, NChar, NVarChar, VarChar oder Xml verwendet, als Value auf TextReader festgelegt wurde.A SqlDbType other than Char, NChar, NVarChar, VarChar, or Xml was used when Value was set to TextReader.

- oder --or-

Es wurde ein anderer SqlDbType als Xml verwendet, als Value auf XmlReader festgelegt wurde.A SqlDbType other than Xml was used when Value was set to XmlReader.

Alle Fehler, die beim Ausführen des Befehlstexts aufgetreten sind.Any error that occurred while executing the command text.

- oder --or-

Bei einem Streamingvorgang ist ein Timeout aufgetreten.A timeout occurred during a streaming operation. Weitere Informationen zum Streaming finden Sie unter SqlClient-Streamingunterstützung.For more information about streaming, see SqlClient Streaming Support.

Das Name-Wert-Paar "Asynchronous Processing=true" war nicht in der Verbindungszeichenfolge enthalten, mit der die Verbindung für diesen SqlCommand definiert wird.The name/value pair "Asynchronous Processing=true" was not included within the connection string defining the connection for this SqlCommand.

- oder --or-

Die SqlConnection wurde während eines Streamingvorgangs geschlossen oder getrennt.The SqlConnection closed or dropped during a streaming operation. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).For more information about streaming, see SqlClient Streaming Support.

Während eines Streamingvorgangs ist bei einem Stream-, XmlReader- oder TextReader-Objekt ein Fehler aufgetreten.An error occurred in a Stream, XmlReader or TextReader object during a streaming operation. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).For more information about streaming, see SqlClient Streaming Support.

Das Stream-, XmlReader - oder TextReader -Objekt wurde während eines Streamingvorgangs geschlossen.The Stream, XmlReader or TextReader object was closed during a streaming operation. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).For more information about streaming, see SqlClient Streaming Support.

Beispiele

In der folgenden Windows-Anwendung wird die Verwendung der BeginExecuteXmlReader-Methode gezeigt, wobei eine Transact-SQL-Anweisung ausgeführt wird, die eine Verzögerung von einigen Sekunden beinhaltet (Emulieren eines zeitintensiven Befehls).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). In diesem Beispiel wird das SqlCommand ausführende Objekt stateObject als-Parameter übergeben, sodass es einfach ist, das SqlCommand Objekt innerhalb der Rückruf Prozedur abzurufen, sodass der Code die EndExecuteXmlReader Methode aufrufen kann, die dem der erste Rückruf BeginExecuteXmlReadervon.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.

In diesem Beispiel werden viele wichtige Techniken veranschaulicht.This example demonstrates many important techniques. Dies schließt das Aufrufen einer Methode ein, die mit dem Formular von einem separaten Thread interagiert.This includes calling a method that interacts with the form from a separate thread. Außerdem wird in diesem Beispiel veranschaulicht, wie Sie verhindern können, dass Benutzer einen Befehl mehrmals parallel ausführen, und wie Sie sicherstellen müssen, dass das Formular nicht geschlossen wird, bevor die Rückruf Prozedur aufgerufen wird.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.

Erstellen Sie zum Einrichten dieses Beispiels eine neue Windows-Anwendung.To set up this example, create a new Windows application. Platzieren Sie Button ein-Steuer ListBox Element, ein- Label Steuerelement und ein-Steuerelement im Formular (übernehmen Sie für jedes Steuerelement den Standardnamen).Put a Button control, a ListBox control, and a Label control on the form (accepting the default name for each control). Fügen Sie der Klasse des Formulars den folgenden Code hinzu, und ändern Sie die Verbindungs Zeichenfolge nach Bedarf für Ihre Umgebung.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

Hinweise

Die BeginExecuteXmlReader -Methode startet die asynchrone Ausführung einer Transact-SQL-Anweisung oder einer gespeicherten Prozedur, die Zeilen als XML zurückgibt, damit andere Tasks gleichzeitig ausgeführt werden können, während die Anweisung ausgeführt wird.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. Wenn die-Anweisung abgeschlossen ist, müssen Entwickler die EndExecuteXmlReader -Methode aufrufen, um den Vorgang abzuschließen und die angeforderten XML-Daten abzurufen.When the statement has completed, developers must call the EndExecuteXmlReader method to finish the operation and retrieve the requested XML data. Die BeginExecuteXmlReader Methode wird sofort zurückgegeben, aber bis der Code den EndExecuteXmlReader entsprechenden Methodenaufruf ausführt, dürfen keine anderen Aufrufe ausgeführt werden, die eine synchrone oder asynchrone Ausführung für SqlCommand dasselbe Objekt starten.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. Wenn aufgerufen wird, SqlCommand bevordieAusführungdesBefehlsabgeschlossenist,wirddas-Objektblockiert,bisdieAusführungabgeschlossenist.EndExecuteXmlReaderCalling the EndExecuteXmlReader before the command's execution is completed causes the SqlCommand object to block until the execution is finished.

Die CommandText -Eigenschaft gibt normalerweise eine Transact-SQL-Anweisung mit einer gültigen for XML-Klausel an.The CommandText property ordinarily specifies a Transact-SQL statement with a valid FOR XML clause. CommandText Kann jedoch auch eine-Anweisung angeben, die Daten zurückgibt, die gültiges XML enthalten.However, CommandText can also specify a statement that returns data that contains valid XML. Diese Methode kann auch verwendet werden, um ein einzeiliges, einzeiliges Resultset abzurufen.This method can also be used to retrieve a single-row, single-column result set. Wenn in diesem Fall mehr als eine Zeile zurückgegeben wird, fügt EndExecuteXmlReader die-Methode XmlReader den an den Wert in der ersten Zeile an und verwirft den Rest des Resultsets.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.

Eine typische BeginExecuteXmlReader Abfrage kann wie im folgenden C# Beispiel formatiert werden: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);  

Diese Methode kann auch verwendet werden, um ein einzeiliges, einzeiliges Resultset abzurufen.This method can also be used to retrieve a single-row, single-column result set. Wenn in diesem Fall mehr als eine Zeile zurückgegeben wird, fügt EndExecuteXmlReader die-Methode XmlReader den an den Wert in der ersten Zeile an und verwirft den Rest des Resultsets.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.

Mit der Mars-Funktion (Multiple Active Result Set) können mehrere Aktionen dieselbe Verbindung verwenden.The multiple active result set (MARS) feature lets multiple actions use the same connection.

Mit callback dem-Parameter können Sie AsyncCallback einen-Delegaten angeben, der aufgerufen wird, wenn die-Anweisung abgeschlossen wurde.The callback parameter lets you specify an AsyncCallback delegate that is called when the statement has completed. Sie können die EndExecuteXmlReader -Methode in dieser Delegatprozedur oder an einem beliebigen anderen Speicherort innerhalb der Anwendung abrufen.You can call the EndExecuteXmlReader method from within this delegate procedure, or from any other location within your application. Darüber hinaus können Sie ein beliebiges-Objekt im stateObject -Parameter übergeben, und Ihre Rückruf Prozedur kann diese Informationen mithilfe AsyncState der-Eigenschaft abrufen.In addition, you can pass any object in the stateObject parameter, and your callback procedure can retrieve this information using the AsyncState property.

Beachten Sie, dass der Befehls Text und die Parameter synchron an den Server gesendet werden.Note that the command text and parameters are sent to the server synchronously. Wenn ein großer Befehl oder viele Parameter gesendet werden, kann diese Methode während Schreibvorgängen blockiert werden.If a large command or many parameters is sent, this method may block during writes. Nachdem der Befehl gesendet wurde, wird die Methode sofort zurückgegeben, ohne auf eine Antwort vom Server zu warten, d. h., die Lesevorgänge sind asynchron.After the command is sent, the method returns immediately without waiting for an answer from the server--that is, reads are asynchronous.

Alle Fehler, die während der Ausführung des Vorgangs auftreten, werden als Ausnahmen in der Rückruf Prozedur ausgelöst.All errors that occur during the execution of the operation are thrown as exceptions in the callback procedure. Sie müssen die Ausnahme in der Rückruf Prozedur und nicht in der Hauptanwendung behandeln.You must handle the exception in the callback procedure, not in the main application. Weitere Informationen zur Behandlung von Ausnahmen in der Rückruf Prozedur finden Sie im Beispiel in diesem Thema.See the example in this topic for additional information on handling exceptions in the callback procedure.

Wenn Sie oder ExecuteReader BeginExecuteReader verwenden, um auf XML-Daten zuzugreifen, gibt SQL Server alle XML-Ergebnisse zurück, die mehr als 2.033 Zeichen lang sind und in mehreren Zeilen mit jeweils 2.033 Zeichen enthalten sind.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. Um dieses Verhalten zu vermeiden, ExecuteXmlReader verwenden BeginExecuteXmlReader Sie oder zum Lesen von for XML-Abfragen.To avoid this behavior, use ExecuteXmlReader or BeginExecuteXmlReader to read FOR XML queries.

Siehe auch

Gilt für: