Freigeben über


SqlCommand.BeginExecuteXmlReader Methode

Definition

Überlädt

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.

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.

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.

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

Gibt zurück

Ein IAsyncResult , der zum Abfragen oder Warten auf Ergebnisse oder beides verwendet werden kann. Dieser Wert wird auch beim Aufrufen vonEndExecuteXmlReader , der einen einzelnen XML-Wert zurückgibt.

Ausnahmen

Ein SqlDbType anderes als Binary oder VarBinary wurde verwendet, wenn Value auf Stream festgelegt wurde. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).

- oder -

Ein SqlDbType anderes als Char, NChar, NVarChar, VarChar oder Xml wurde verwendet, wenn Value auf TextReader festgelegt wurde.

Oder

Ein SqlDbType anderer als Xml wurde verwendet, wenn Value auf XmlReader festgelegt wurde.

Alle Fehler, die beim Ausführen des Befehlstexts aufgetreten sind.

- oder -

Bei einem Streamingvorgang ist ein Timeout aufgetreten. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).

Die SqlConnection wurde während eines Streamingvorgangs geschlossen oder getrennt. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).

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

Während eines Streamingvorgangs ist ein Fehler in einem Stream - XmlReader oder TextReader -Objekt aufgetreten. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).

Das Stream - XmlReader oder TextReader -Objekt wurde während eines Streamingvorgangs geschlossen. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).

Beispiele

Die folgende Konsolenanwendung startet den Prozess zum asynchronen Abrufen von XML-Daten. Während sie auf die Ergebnisse wartet, befindet sich diese einfache Anwendung in einer Schleife und untersucht den IsCompleted Eigenschaftswert. Nachdem der Prozess abgeschlossen ist, ruft der Code die XML ab und zeigt seinen Inhalt an.

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

Hinweise

Die BeginExecuteXmlReader -Methode startet den Prozess der asynchronen Ausführung einer Transact-SQL-Anweisung, die Zeilen als XML zurückgibt, sodass andere Aufgaben gleichzeitig ausgeführt werden können, während die Anweisung ausgeführt wird. Wenn die Anweisung abgeschlossen ist, müssen Entwickler die EndExecuteXmlReader -Methode aufrufen, um den Vorgang abzuschließen und den vom Befehl zurückgegebenen XML-Code abzurufen. Die BeginExecuteXmlReader -Methode gibt sofort zurück, aber bis der Code den entsprechenden EndExecuteXmlReader Methodenaufruf ausführt, darf sie keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung für dasselbe SqlCommand Objekt starten. Wenn Sie die EndExecuteXmlReader aufrufen, bevor die Ausführung des Befehls abgeschlossen ist, wird das SqlCommand Objekt blockiert, bis die Ausführung abgeschlossen ist.

Die CommandText -Eigenschaft gibt normalerweise eine Transact-SQL-Anweisung mit einer gültigen FOR XML-Klausel an. Kann jedoch auch eine -Anweisung angeben, CommandText die Daten zurückgibt ntext , die gültiges XML enthalten.

Eine typische BeginExecuteXmlReader Abfrage kann wie im folgenden C#-Beispiel formatiert werden:

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

Diese Methode kann auch verwendet werden, um ein einspaltiges Resultset abzurufen. Wenn in diesem Fall mehr als eine Zeile zurückgegeben wird, fügt die EndExecuteXmlReader -Methode an XmlReader den Wert in der ersten Zeile an und verwirft den Rest des Resultsets.

Mit der Mars-Funktion (Multiple Active Result Set) können mehrere Aktionen dieselbe Verbindung verwenden.

Beachten Sie, dass der Befehlstext und die Parameter synchron an den Server gesendet werden. Wenn ein großer Befehl oder viele Parameter gesendet werden, kann diese Methode während Schreibvorgängen blockiert werden. Nachdem der Befehl gesendet wurde, gibt die Methode sofort zurück, ohne auf eine Antwort vom Server zu warten, d. h. Lesevorgänge sind asynchron. Obwohl die Befehlsausführung asynchron ist, ist das Abrufen von Werten immer noch synchron.

Da diese Überladung keine Rückrufprozedur unterstützt, müssen Entwickler entweder abfragen, um zu bestimmen, ob der Befehl abgeschlossen wurde, indem sie die IsCompleted -Eigenschaft des IAsyncResult von der BeginExecuteXmlReader -Methode zurückgegebenen verwenden, oder auf den Abschluss eines oder mehrerer Befehle mit der AsyncWaitHandle -Eigenschaft des zurückgegebenen IAsyncResultwarten.

Wenn Sie oder BeginExecuteReader für den Zugriff auf XML-Daten verwendenExecuteReader, gibt SQL Server xml-Ergebnisse mit einer Länge von mehr als 2.033 Zeichen in mehreren Zeilen mit jeweils 2.033 Zeichen zurück. Um dieses Verhalten zu vermeiden, verwenden Sie ExecuteXmlReader oder BeginExecuteXmlReader , um FOR XML-Abfragen zu lesen.

Diese Methode ignoriert die CommandTimeout -Eigenschaft.

Gilt für:

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.

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

Ein AsyncCallback-Delegat, der aufgerufen wird, wenn die Ausführung des Befehls abgeschlossen wurde. Passnull ( Nothing in Microsoft Visual Basic), um anzugeben, dass kein Rückruf erforderlich ist.

stateObject
Object

Ein benutzerdefiniertes Zustandsobjekt, das an die Rückrufprozedur übergeben wird. Rufen Sie dieses Objekt innerhalb der Rückrufprozedur mit der AsyncState-Eigenschaft ab.

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.

Ausnahmen

Ein SqlDbType anderes als Binary oder VarBinary wurde verwendet, wenn Value auf Stream festgelegt wurde. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).

- oder -

Ein SqlDbType anderes als Char, NChar, NVarChar, VarChar oder Xml wurde verwendet, wenn Value auf TextReader festgelegt wurde.

Oder

Ein SqlDbType anderer als Xml wurde verwendet, wenn Value auf XmlReader festgelegt wurde.

Alle Fehler, die beim Ausführen des Befehlstexts aufgetreten sind.

- oder -

Bei einem Streamingvorgang ist ein Timeout aufgetreten. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).

Die SqlConnection wurde während eines Streamingvorgangs geschlossen oder getrennt. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).

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

Während eines Streamingvorgangs ist ein Fehler in einem Stream - XmlReader oder TextReader -Objekt aufgetreten. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).

Das Stream - XmlReader oder TextReader -Objekt wurde während eines Streamingvorgangs geschlossen. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).

Beispiele

Die folgende Windows-Anwendung veranschaulicht die Verwendung der BeginExecuteXmlReader-Methode, bei der (zum Emulieren eines Befehls mit langer Ausführungszeit) eine Transact-SQL-Anweisung mit einer Verzögerung von einigen Sekunden ausgeführt wird. In diesem Beispiel wird das ausführende SqlCommand Objekt als stateObject Parameter übergeben. Dadurch ist es einfach, das Objekt aus der SqlCommand Rückrufprozedur abzurufen, sodass der Code die EndExecuteXmlReader -Methode aufrufen kann, die dem anfänglichen Aufruf BeginExecuteXmlReadervon entspricht.

In diesem Beispiel werden viele wichtige Techniken veranschaulicht. Dies schließt den Aufruf einer Methode ein, die mit dem Formular aus einem separaten Thread interagiert. Darüber hinaus veranschaulicht dieses Beispiel, wie Sie verhindern müssen, dass Benutzer einen Befehl mehrmals gleichzeitig ausführen, und wie Sie sicherstellen müssen, dass das Formular nicht geschlossen wird, bevor die Rückrufprozedur aufgerufen wird.

Um dieses Beispiel einzurichten, erstellen Sie eine neue Windows-Anwendung. Platzieren Sie ein Button -Steuerelement, ein ListBox -Steuerelement und ein Label -Steuerelement auf dem Formular (wobei der Standardname für jedes Steuerelement akzeptiert wird). Fügen Sie der Klasse des Formulars den folgenden Code hinzu, und ändern Sie dabei die Verbindungszeichenfolge nach Bedarf für Ihre Umgebung.

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

Hinweise

Die BeginExecuteXmlReader -Methode startet den Prozess der asynchronen Ausführung einer Transact-SQL-Anweisung oder einer gespeicherten Prozedur, die Zeilen als XML zurückgibt, sodass andere Aufgaben gleichzeitig ausgeführt werden können, während die Anweisung ausgeführt wird. Wenn die Anweisung abgeschlossen ist, müssen Entwickler die EndExecuteXmlReader -Methode aufrufen, um den Vorgang abzuschließen und die angeforderten XML-Daten abzurufen. Die BeginExecuteXmlReader -Methode gibt sofort zurück, aber bis der Code den entsprechenden EndExecuteXmlReader Methodenaufruf ausführt, darf sie keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung für dasselbe SqlCommand Objekt starten. Wenn Sie die EndExecuteXmlReader aufrufen, bevor die Ausführung des Befehls abgeschlossen ist, wird das SqlCommand Objekt blockiert, bis die Ausführung abgeschlossen ist.

Die CommandText -Eigenschaft gibt normalerweise eine Transact-SQL-Anweisung mit einer gültigen FOR XML-Klausel an. Kann jedoch auch eine -Anweisung angeben, CommandText die Daten zurückgibt, die gültiges XML enthalten. Diese Methode kann auch verwendet werden, um ein einspaltiges Resultset abzurufen. Wenn in diesem Fall mehr als eine Zeile zurückgegeben wird, fügt die EndExecuteXmlReader -Methode an XmlReader den Wert in der ersten Zeile an und verwirft den Rest des Resultsets.

Eine typische BeginExecuteXmlReader Abfrage kann wie im folgenden C#-Beispiel formatiert werden:

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

Diese Methode kann auch verwendet werden, um ein einspaltiges Resultset abzurufen. Wenn in diesem Fall mehr als eine Zeile zurückgegeben wird, fügt die EndExecuteXmlReader -Methode an XmlReader den Wert in der ersten Zeile an und verwirft den Rest des Resultsets.

Mit der Mars-Funktion (Multiple Active Result Set) können mehrere Aktionen dieselbe Verbindung verwenden.

Mit callback dem Parameter können Sie einen AsyncCallback Delegaten angeben, der aufgerufen wird, wenn die Anweisung abgeschlossen ist. Sie können die EndExecuteXmlReader -Methode innerhalb dieser Delegatprozedur oder von einem beliebigen anderen Speicherort in Ihrer Anwendung aufrufen. Darüber hinaus können Sie jedes Objekt im stateObject Parameter übergeben, und Ihre Rückrufprozedur kann diese Informationen mithilfe der AsyncState -Eigenschaft abrufen.

Beachten Sie, dass der Befehlstext und die Parameter synchron an den Server gesendet werden. Wenn ein großer Befehl oder viele Parameter gesendet werden, kann diese Methode während Schreibvorgängen blockiert werden. Nachdem der Befehl gesendet wurde, gibt die Methode sofort zurück, ohne auf eine Antwort vom Server zu warten, d. h. Lesevorgänge sind asynchron.

Alle Fehler, die während der Ausführung des Vorgangs auftreten, werden in der Rückrufprozedur als Ausnahmen ausgelöst. Sie müssen die Ausnahme in der Rückrufprozedur behandeln, nicht in der Hauptanwendung. Weitere Informationen zur Behandlung von Ausnahmen in der Rückrufprozedur finden Sie im Beispiel in diesem Thema.

Wenn Sie oder BeginExecuteReader für den Zugriff auf XML-Daten verwendenExecuteReader, gibt SQL Server xml-Ergebnisse mit einer Länge von mehr als 2.033 Zeichen in mehreren Zeilen mit jeweils 2.033 Zeichen zurück. Um dieses Verhalten zu vermeiden, verwenden Sie ExecuteXmlReader oder BeginExecuteXmlReader , um FOR XML-Abfragen zu lesen.

Diese Methode ignoriert die CommandTimeout -Eigenschaft.

Weitere Informationen

Gilt für: