Freigeben über


SqlCommand.BeginExecuteReader Methode

Definition

Überlädt

BeginExecuteReader()

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.

BeginExecuteReader(CommandBehavior)

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand unter Verwendung eines der CommandBehavior-Werte beschrieben wird.

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

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, unter Verwendung einer derCommandBehavior -Werte und abrufen eines oder mehrerer Resultsets vom Server, wenn eine Rückrufprozedur und Zustandsinformationen angegeben werden.

BeginExecuteReader()

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 ^ BeginExecuteReader();
public IAsyncResult BeginExecuteReader ();
member this.BeginExecuteReader : unit -> IAsyncResult
Public Function BeginExecuteReader () As IAsyncResult

Gibt zurück

Ein IAsyncResult , das zum Abfragen oder Warten auf Ergebnisse oder beides verwendet werden kann. Dieser Wert wird auch beim Aufrufen benötigt.EndExecuteXmlReader , 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 anderes 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. Nach Abschluss des Prozesses ruft der Code den XML-Code 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 die vom Befehl zurückgegebene XML 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. Das Aufrufen von EndExecuteXmlReader vor Abschluss der Ausführung des Befehls bewirkt, dass das SqlCommand Objekt blockiert wird, 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ültige 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 zum Abrufen eines einzeilenigen, einspaltigen Resultsets verwendet werden. Wenn in diesem Fall mehr als eine Zeile zurückgegeben wird, fügt die EndExecuteXmlReader -Methode den XmlReader an den Wert in der ersten Zeile an und verwirft den Rest des Resultsets.

Mit dem Feature "Multiple Active Result Set" (MARS) 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 beim Schreiben blockiert werden. Nachdem der Befehl gesendet wurde, gibt die -Methode sofort zurück, ohne auf eine Antwort vom Server zu warten. Lesevorgänge sind also asynchron. Obwohl die Befehlsausführung asynchron ist, ist der Wertabruf immer noch synchron.

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

Wenn Sie XML-Daten verwenden ExecuteReader oder BeginExecuteReader darauf zugreifen, 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. Verwenden Oder BeginExecuteXmlReader lesen Sie FOR XML-Abfragen, ExecuteXmlReader um dieses Verhalten zu vermeiden.

Diese Methode ignoriert die CommandTimeout -Eigenschaft.

Gilt für:

BeginExecuteReader(CommandBehavior)

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand unter Verwendung eines der CommandBehavior-Werte beschrieben wird.

public:
 IAsyncResult ^ BeginExecuteReader(System::Data::CommandBehavior behavior);
public IAsyncResult BeginExecuteReader (System.Data.CommandBehavior behavior);
member this.BeginExecuteReader : System.Data.CommandBehavior -> IAsyncResult
Public Function BeginExecuteReader (behavior As CommandBehavior) As IAsyncResult

Parameter

behavior
CommandBehavior

Einer der CommandBehavior-Werte, der Optionen zur Ausführung von Anweisungen und zum Abrufen von Daten festlegt.

Gibt zurück

Ein IAsyncResult , das zum Abfragen, Warten auf Ergebnisse oder beides verwendet werden kann. Dieser Wert wird auch beim Aufrufen EndExecuteReader(IAsyncResult) von benötigt, wodurch eine SqlDataReader Instanz zurückgegeben wird, die zum Abrufen der zurückgegebenen Zeilen verwendet werden kann.

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 anderes 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 Vorgang zum asynchronen Abrufen eines Datenlesers. Während sie auf die Ergebnisse wartet, befindet sich diese einfache Anwendung in einer Schleife und untersucht den IsCompleted Eigenschaftswert. Nach Abschluss des Prozesses ruft der Code den SqlDataReader ab und zeigt seinen Inhalt an.

Dieses Beispiel übergibt auch die CommandBehavior.CloseConnection Werte und CommandBehavior.SingleRow im Verhaltensparameter, wodurch die Verbindung geschlossen wird, wenn das zurückgegebene SqlDataReader geschlossen wird, und um für ein einzelnes Zeilenergebnis zu optimieren.

// <Snippet1>
using System;
using System.Data;
using Microsoft.Data.SqlClient;
class Class1
{
    static void Main()
    {
        // This example is not terribly useful, 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 ProductID, Name FROM Production.Product WHERE ListPrice < 100";

        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. 

        try
        {
            // The code does not need to handle closing the connection explicitly--
            // the use of the CommandBehavior.CloseConnection option takes care
            // of that for you. 
            SqlConnection connection = new SqlConnection(connectionString);
            SqlCommand command = new SqlCommand(commandText, connection);

            connection.Open();
            IAsyncResult result = command.BeginExecuteReader(
                CommandBehavior.CloseConnection);

            // Although it is not necessary, the following code
            // 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);
            }

            using (SqlDataReader reader = command.EndExecuteReader(result))
            {
                DisplayResults(reader);
            }
        }
        catch (SqlException ex)
        {
            Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message);
        }
        catch (InvalidOperationException ex)
        {
            Console.WriteLine("Error: {0}", ex.Message);
        }
        catch (Exception ex)
        {
            // You might want to pass these errors
            // back out to the caller.
            Console.WriteLine("Error: {0}", ex.Message);
        }
    }

    private static void DisplayResults(SqlDataReader reader)
    {
        // Display the data within the reader.
        while (reader.Read())
        {
            // Display all the columns. 
            for (int i = 0; i < reader.FieldCount; i++)
            {
                Console.Write("{0}\t", reader.GetValue(i));
            }
            Console.WriteLine();
        }
    }

    private static 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";
    }
}
// </Snippet1>

Hinweise

Die BeginExecuteReader -Methode startet den Prozess der asynchronen Ausführung einer Transact-SQL-Anweisung oder einer gespeicherten Prozedur, die Zeilen 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 EndExecuteReader -Methode aufrufen, um den Vorgang abzuschließen und die SqlDataReader vom Befehl zurückgegebene abzurufen. Die BeginExecuteReader -Methode gibt sofort zurück, aber bis der Code den entsprechenden EndExecuteReader Methodenaufruf ausführt, darf sie keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung für dasselbe SqlCommand Objekt starten. Das Aufrufen von EndExecuteReader vor Abschluss der Ausführung des Befehls bewirkt, dass das SqlCommand Objekt blockiert wird, bis die Ausführung abgeschlossen ist.

Mit behavior dem Parameter können Sie Optionen angeben, die das Verhalten des Befehls und seiner Verbindung steuern. Diese Werte können zusammen kombiniert werden (mit dem Operator der Programmiersprache OR ). In der Regel verwenden Entwickler den CommandBehavior.CloseConnection Wert, um sicherzustellen, dass die Verbindung von der Runtime geschlossen wird, wenn die SqlDataReader geschlossen ist.

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 beim Schreiben blockiert werden. Nachdem der Befehl gesendet wurde, gibt die -Methode sofort zurück, ohne auf eine Antwort vom Server zu warten. Lesevorgänge sind also asynchron. Obwohl die Befehlsausführung asynchron ist, ist der Wertabruf immer noch synchron. Dies bedeutet, dass Aufrufe von Read möglicherweise blockieren, wenn weitere Daten erforderlich sind und die lesevorgangsblöcke des zugrunde liegenden Netzwerks blockiert werden.

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

Wenn Sie XML-Daten verwenden ExecuteReader oder BeginExecuteReader darauf zugreifen, 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. Verwenden Oder BeginExecuteXmlReader lesen Sie FOR XML-Abfragen, ExecuteXmlReader um dieses Verhalten zu vermeiden.

Diese Methode ignoriert die CommandTimeout -Eigenschaft.

Gilt für:

BeginExecuteReader(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 ^ BeginExecuteReader(AsyncCallback ^ callback, System::Object ^ stateObject);
public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject);
member this.BeginExecuteReader : AsyncCallback * obj -> IAsyncResult
Public Function BeginExecuteReader (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 wird es einfach, das Objekt aus der SqlCommand Rückrufprozedur abzurufen, sodass der Code die -Methode aufrufen kann, die EndExecuteXmlReader dem anfänglichen Aufruf BeginExecuteXmlReadervon entspricht.

In diesem Beispiel werden viele wichtige Techniken veranschaulicht. Dies schließt das Aufrufen 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 im Formular (wobei der Standardname für jedes Steuerelement akzeptiert wird). Fügen Sie der Klasse des Formulars den folgenden Code hinzu, und ändern Sie 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:

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, unter Verwendung einer derCommandBehavior -Werte und abrufen eines oder mehrerer Resultsets vom Server, wenn eine Rückrufprozedur und Zustandsinformationen angegeben werden.

public:
 IAsyncResult ^ BeginExecuteReader(AsyncCallback ^ callback, System::Object ^ stateObject, System::Data::CommandBehavior behavior);
public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject, System.Data.CommandBehavior behavior);
member this.BeginExecuteReader : AsyncCallback * obj * System.Data.CommandBehavior -> IAsyncResult
Public Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object, behavior As CommandBehavior) 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.

behavior
CommandBehavior

Einer der CommandBehavior-Werte, der Optionen zur Ausführung von Anweisungen und zum Abrufen von Daten festlegt.

Gibt zurück

Ein IAsyncResult , das zum Abfragen oder Warten auf Ergebnisse oder beides verwendet werden kann. Dieser Wert wird auch beim Aufrufen EndExecuteReader(IAsyncResult) von benötigt, wodurch eine SqlDataReader Instanz zurückgegeben wird, die zum Abrufen der zurückgegebenen Zeilen verwendet werden kann.

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 BeginExecuteReader-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. Da im Beispiel der Befehl asynchron ausgeführt wird, bleibt das Formular reaktionsfähig, während es auf die Ergebnisse wartet. In diesem Beispiel wird das ausführende SqlCommand Objekt als stateObject Parameter übergeben. Dadurch wird es einfach, das Objekt aus der SqlCommand Rückrufprozedur abzurufen, sodass der Code die EndExecuteReader -Methode aufrufen kann, die dem anfänglichen Aufruf von BeginExecuteReaderentspricht.

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

In diesem Beispiel wird der CommandBehavior.CloseConnection Wert im behavior -Parameter übergeben, sodass die zurückgegebene SqlDataReader die Verbindung automatisch schließt, wenn sie geschlossen wird.

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

namespace Microsoft.AdoDotNet.CodeSamples
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
        // Hook up the form's Load event handler (you can double-click on 
        // the form's design surface in Visual Studio), and then add 
        // this code to the form's class:
        // You need this delegate in order to fill the grid from
        // a thread other than the form's thread. See the HandleCallback
        // procedure for more information.
        private delegate void FillGridDelegate(SqlDataReader reader);

        // You need this delegate to update the status bar.
        private delegate void DisplayStatusDelegate(string Text);

        // This flag ensures that the user does not attempt
        // to restart the command or close the form while the 
        // asynchronous command is executing.
        private bool isExecuting;

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

        private void FillGrid(SqlDataReader reader)
        {
            try
            {
                DataTable table = new DataTable();
                table.Load(reader);
                this.dataGridView1.DataSource = table;
                DisplayStatus("Ready");
            }
            catch (Exception ex)
            {
                // Because you are guaranteed this procedure
                // is running from within the form's thread,
                // it can directly interact with members of the form.
                DisplayStatus(string.Format("Ready (last attempt failed: {0})",
                    ex.Message));
            }
            finally
            {
                // Closing the reader also closes the connection,
                // because this reader was created using the 
                // CommandBehavior.CloseConnection value.
                if (reader != null)
                {
                    reader.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;
                SqlDataReader reader = command.EndExecuteReader(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. Therefore you cannot simply call code that 
                // fills the grid, like this:
                // FillGrid(reader);
                // 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. 
                FillGridDelegate del = new FillGridDelegate(FillGrid);
                this.Invoke(del, reader);
                // Do not close the reader here, because it is being used in 
                // a separate thread. Instead, have the procedure you have
                // called close the reader once it is done with it.
            }
            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 there is none of 
                // your code 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 DisplayStatusDelegate(DisplayStatus), "Error: " +
                    ex.Message);
            }
            finally
            {
                isExecuting = false;
            }
        }

        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 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;
                SqlConnection connection = null;
                try
                {
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());
                    // To emulate a long-running query, wait for 
                    // a few seconds before retrieving the real data.
                    command = new SqlCommand("WAITFOR DELAY '0:0:5';" +
                        "SELECT ProductID, Name, ListPrice, Weight FROM Production.Product",
                        connection);
                    connection.Open();

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the 
                    // SqlCommand object as the second parameter in the 
                    // BeginExecuteReader call, doing so makes it easier
                    // to call EndExecuteReader in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteReader(callback, command,
                        CommandBehavior.CloseConnection);
                }
                catch (Exception ex)
                {
                    DisplayStatus("Error: " + ex.Message);
                    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 FormClosingEventHandler(Form1_FormClosing);
        }

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

Hinweise

Die BeginExecuteReader -Methode startet den Prozess der asynchronen Ausführung einer Transact-SQL-Anweisung oder einer gespeicherten Prozedur, die Zeilen 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 EndExecuteReader -Methode aufrufen, um den Vorgang abzuschließen und die SqlDataReader vom Befehl zurückgegebene abzurufen. Die BeginExecuteReader -Methode gibt sofort zurück, aber bis der Code den entsprechenden EndExecuteReader 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 EndExecuteReader aufrufen, bevor die Ausführung des Befehls abgeschlossen ist, wird das SqlCommand Objekt blockiert, bis die Ausführung abgeschlossen ist.

Mit callback dem Parameter können Sie einen AsyncCallback Delegaten angeben, der aufgerufen wird, wenn die Anweisung abgeschlossen ist. Sie können die EndExecuteReader -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.

Mit behavior dem Parameter können Sie Optionen angeben, die das Verhalten des Befehls und seiner Verbindung steuern. Diese Werte können kombiniert werden (mit dem Operator der Programmiersprache Or ). Im Allgemeinen verwenden Entwickler den CloseConnection Wert, um sicherzustellen, dass die Verbindung von der Runtime geschlossen wird, wenn geschlossen SqlDataReader wird. Entwickler können auch das Verhalten von SqlDataReader optimieren, indem sie den SingleRow Wert angeben, wenn im Voraus bekannt ist, dass die Transact-SQL-Anweisung oder gespeicherte Prozedur nur eine einzelne Zeile zurückgibt.

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. Dies bedeutet, dass Aufrufe von Read möglicherweise blockiert werden, wenn mehr Daten erforderlich sind und der Lesevorgang des zugrunde liegenden Netzwerks blockiert wird.

Da die Rückrufprozedur in einem Hintergrundthread ausgeführt wird, der von der Microsoft .NET Common Language Runtime bereitgestellt wird, ist es sehr wichtig, dass Sie einen rigorosen Ansatz für die Behandlung threadübergreifender Interaktionen innerhalb Ihrer Anwendungen verwenden. Sie dürfen beispielsweise nicht mit dem Inhalt eines Formulars innerhalb Ihrer Rückrufprozedur interagieren. Wenn Sie das Formular aktualisieren müssen, müssen Sie zurück zum Thread des Formulars wechseln, um Ihre Arbeit zu erledigen. Das Beispiel in diesem Thema veranschaulicht dieses Verhalten.

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.

Gilt für: