SqlCommand.BeginExecuteReader Methode

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

public:
 IAsyncResult ^ BeginExecuteReader();

public IAsyncResult BeginExecuteReader();

member this.BeginExecuteReader : unit -> IAsyncResult

Public Function BeginExecuteReader () As IAsyncResult

Gibt zurück

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

Ausnahmen

Beispiele

Die folgende Konsolenanwendung startet den Prozess des asynchronen Abrufens eines Datenlesers. Während sie auf die Ergebnisse warten, befindet sich diese einfache Anwendung in einer Schleife und untersucht den IsCompleted Eigenschaftswert. Sobald der Prozess abgeschlossen ist, ruft der Code den SqlDataReader Inhalt ab und zeigt den Inhalt an.

using System;
using Microsoft.Data.SqlClient;

class Class1
{
    static void Main()
    {
        // This is a simple example that demonstrates the usage of the
        // BeginExecuteReader functionality
        // The WAITFOR statement simply adds enough time to prove the
        // asynchronous nature of the command.
        string commandText =
            "WAITFOR DELAY '00:00:03';" +
            "SELECT LastName, FirstName FROM Person.Contact " +
            "WHERE LastName LIKE 'M%'";

        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))
        {
            try
            {
                SqlCommand command = new SqlCommand(commandText, connection);

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

                // 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)
                {
                    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.
                    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";
    }
}

Hinweise

Die BeginExecuteReader() Methode startet den Prozess der asynchronen Ausführung einer Transact-SQL-Anweisung oder gespeicherten Prozedur, die Zeilen zurückgibt, sodass andere Aufgaben gleichzeitig ausgeführt werden können, während die Anweisung ausgeführt wird. Nach Abschluss der Anweisung müssen Entwickler die EndExecuteReader(IAsyncResult) Methode aufrufen, um den Vorgang abzuschließen und den SqlDataReader vom Befehl zurückgegebenen Abruf abzurufen. Die BeginExecuteReader() Methode wird sofort zurückgegeben, aber bis der Code den entsprechenden EndExecuteReader(IAsyncResult) Methodenaufruf ausführt, darf er keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung für dasselbe SqlCommand Objekt starten. Das Aufrufen der EndExecuteReader(IAsyncResult) Ausführung des Befehls bewirkt, dass das SqlCommand Objekt blockiert wird, bis die Ausführung abgeschlossen 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 während der Schreibvorgänge 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 Read() blockieren können, wenn weitere Daten erforderlich sind und die Lesevorgänge des zugrunde liegenden Netzwerks blockiert werden.

Da diese Überladung keine Rückrufprozedur unterstützt, müssen Entwickler entweder abfragen, um zu bestimmen, ob der Befehl abgeschlossen ist, indem die IsCompleted Eigenschaft der IAsyncResult von der BeginExecuteReader() Methode zurückgegebenen Eigenschaft verwendet wird, oder warten Sie mit der AsyncWaitHandle Eigenschaft der zurückgegebenen IAsyncResultBefehle auf den Abschluss eines oder mehrerer Befehle.

Wenn Sie XML-Daten verwenden ExecuteReader() oder BeginExecuteReader() darauf zugreifen, gibt SQL Server alle XML-Ergebnisse zurück, die größer als 2.033 Zeichen in mehreren Zeilen mit jeweils 2.033 Zeichen sind. Verwenden Oder ExecuteXmlReader() lesen Sie BeginExecuteXmlReader() FOR XML-Abfragen, um dieses Verhalten zu vermeiden.

Diese Methode ignoriert die CommandTimeout Eigenschaft.

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

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

Gibt zurück

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

Ausnahmen

Beispiele

Die folgende Konsolenanwendung startet den Prozess des asynchronen Abrufens eines Datenlesers. Während sie auf die Ergebnisse warten, befindet sich diese einfache Anwendung in einer Schleife und untersucht den IsCompleted Eigenschaftswert. Sobald der Prozess abgeschlossen ist, ruft der Code den SqlDataReader Inhalt ab und zeigt den Inhalt an.

In diesem Beispiel werden auch die Werte CloseConnection und Werte SingleRow im Verhaltensparameter übergeben, wodurch die Verbindung geschlossen wird, wenn die zurückgegebene SqlDataReader Verbindung geschlossen wird und für ein einzelnes Zeilenergebnis optimiert wird.

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";
    }
}

Hinweise

Die BeginExecuteReader() Methode startet den Prozess der asynchronen Ausführung einer Transact-SQL-Anweisung oder gespeicherten Prozedur, die Zeilen zurückgibt, sodass andere Aufgaben gleichzeitig ausgeführt werden können, während die Anweisung ausgeführt wird. Nach Abschluss der Anweisung müssen Entwickler die EndExecuteReader(IAsyncResult) Methode aufrufen, um den Vorgang abzuschließen und den SqlDataReader vom Befehl zurückgegebenen Abruf abzurufen. Die BeginExecuteReader() Methode wird sofort zurückgegeben, aber bis der Code den entsprechenden EndExecuteReader(IAsyncResult) Methodenaufruf ausführt, darf er keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung für dasselbe SqlCommand Objekt starten. Das Aufrufen der EndExecuteReader(IAsyncResult) Ausführung des Befehls bewirkt, dass das SqlCommand Objekt blockiert wird, bis die Ausführung abgeschlossen ist.

Mit dem behavior 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 CommandBehavior.CloseConnection Wert, um sicherzustellen, dass die Verbindung durch die Laufzeit geschlossen wird, wenn sie SqlDataReader geschlossen wird.

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 der Schreibvorgänge 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 Read() blockieren können, wenn weitere Daten erforderlich sind und die Lesevorgänge des zugrunde liegenden Netzwerks blockiert werden.

Da diese Überladung keine Rückrufprozedur unterstützt, müssen Entwickler entweder abfragen, um zu bestimmen, ob der Befehl abgeschlossen ist, indem die IsCompleted Eigenschaft der IAsyncResult von der BeginExecuteNonQuery() Methode zurückgegebenen Eigenschaft verwendet wird, oder warten Sie mit der AsyncWaitHandle Eigenschaft der zurückgegebenen IAsyncResultBefehle auf den Abschluss eines oder mehrerer Befehle.

Wenn Sie XML-Daten verwenden ExecuteReader() oder BeginExecuteReader() darauf zugreifen, gibt SQL Server alle XML-Ergebnisse zurück, die größer als 2.033 Zeichen in mehreren Zeilen mit jeweils 2.033 Zeichen sind. Verwenden Oder ExecuteXmlReader() lesen Sie BeginExecuteXmlReader() FOR XML-Abfragen, um dieses Verhalten zu vermeiden.

Diese Methode ignoriert die CommandTimeout Eigenschaft.

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

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

Gibt zurück

Ein IAsyncResult Wert, der zum Abrufen, Warten auf Ergebnisse oder beides verwendet werden kann. Dieser Wert wird auch benötigt, wenn der EndExecuteXmlReader(IAsyncResult) Aufruf erfolgt, der die Ergebnisse des Befehls als XML zurückgibt.

Ausnahmen

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

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 ausgeführte SqlCommand Objekt als stateObject Parameter übergeben. Dadurch kann das SqlCommand Objekt einfach aus der Rückrufprozedur abgerufen werden, sodass der Code die EndExecuteXmlReader Methode aufrufen kann, die dem anfänglichen Aufruf entspricht BeginExecuteXmlReader.

In diesem Beispiel werden viele wichtige Techniken veranschaulicht. Dazu gehört das Aufrufen einer Methode, die mit dem Formular über einen separaten Thread interagiert. Darüber hinaus wird in diesem Beispiel veranschaulicht, 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.

/* This does not compile, as multiple methods are missing.
// <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 SqlCommand_BeginExecuteXmlReaderAsync
{
    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 wird sofort zurückgegeben, aber bis der Code den entsprechenden EndExecuteXmlReader Methodenaufruf ausführt, darf er keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung für dasselbe SqlCommand Objekt starten. Das Aufrufen der EndExecuteXmlReader Ausführung des Befehls bewirkt, dass das SqlCommand Objekt blockiert wird, bis die Ausführung abgeschlossen ist.

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

Mit dem Feature für mehrere aktive Resultset (MARS) können mehrere Aktionen dieselbe Verbindung verwenden.

Mit dem callback Parameter können Sie einen AsyncCallback Delegaten angeben, der aufgerufen wird, wenn die Anweisung abgeschlossen ist. Sie können die EndExecuteXmlReader Methode innerhalb dieser Stellvertretungsprozedur 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 blockieren. 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 als Ausnahmen in der Rückrufprozedur ausgelöst. Sie müssen die Ausnahme in der Rückrufprozedur behandeln, nicht in der Hauptanwendung. Weitere Informationen zum Behandeln von Ausnahmen in der Rückrufprozedur finden Sie im Beispiel in diesem Thema.

Wenn Sie XML-Daten verwenden ExecuteReader oder BeginExecuteReader darauf zugreifen, gibt SQL Server alle XML-Ergebnisse zurück, die größer als 2.033 Zeichen in mehreren Zeilen mit jeweils 2.033 Zeichen sind. Verwenden Oder ExecuteXmlReader lesen Sie BeginExecuteXmlReader FOR XML-Abfragen, um dieses Verhalten zu vermeiden.

Diese Methode ignoriert die CommandTimeout Eigenschaft.

Weitere Informationen

• EndExecuteXmlReader(IAsyncResult)
• ExecuteXmlReader()

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

Quelle:

SqlCommand.cs

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

Gibt zurück

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

Ausnahmen

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

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

In diesem Beispiel werden viele wichtige Techniken veranschaulicht. Dazu gehört das Aufrufen einer Methode, die mit dem Formular über einen separaten Thread interagiert. Darüber hinaus wird in diesem Beispiel veranschaulicht, 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 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.

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

#if NETFRAMEWORK
#nullable enable

// <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 SqlCommand_BeginExecuteReaderAsyncBehavior
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
            this.label1 = new Label();
            this.dataGridView1 = new DataGridView();
            this.button1 = new Button();
        }

        private void 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 Label label1 { get; set; }

        private DataGridView dataGridView1 { get; set; }

        private Button button1 { get; set; }

        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>
#endif

Hinweise

Die BeginExecuteReader Methode startet den Prozess der asynchronen Ausführung einer Transact-SQL-Anweisung oder gespeicherten Prozedur, die Zeilen zurückgibt, sodass andere Aufgaben gleichzeitig ausgeführt werden können, während die Anweisung ausgeführt wird. Nach Abschluss der Anweisung müssen Entwickler die EndExecuteReader Methode aufrufen, um den Vorgang abzuschließen und den SqlDataReader vom Befehl zurückgegebenen Abruf abzurufen. Die BeginExecuteReader Methode wird sofort zurückgegeben, aber bis der Code den entsprechenden EndExecuteReader Methodenaufruf ausführt, darf er keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung für dasselbe SqlCommand Objekt starten. Das Aufrufen der EndExecuteReader Ausführung des Befehls bewirkt, dass das SqlCommand Objekt blockiert wird, bis die Ausführung abgeschlossen ist.

Mit dem callback Parameter können Sie einen AsyncCallback Delegaten angeben, der aufgerufen wird, wenn die Anweisung abgeschlossen ist. Sie können die EndExecuteReader Methode innerhalb dieser Stellvertretungsprozedur 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 dem behavior Parameter können Sie Optionen angeben, die das Verhalten des Befehls und seiner Verbindung steuern. Diese Werte können miteinander kombiniert werden (unter Verwendung des Or Operators der Programmiersprache). Im Allgemeinen verwenden Entwickler den CloseConnection Wert, um sicherzustellen, dass die Verbindung durch die Laufzeit geschlossen wird, wenn sie SqlDataReader geschlossen wird. Entwickler können das Verhalten auch 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 der Schreibvorgänge 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 Read blockieren können, wenn weitere Daten erforderlich sind und die Lesevorgänge des zugrunde liegenden Netzwerks blockiert werden.

Da die Rückrufprozedur innerhalb eines Hintergrundthreads ausgeführt wird, der von der Microsoft .NET Common Language Runtime bereitgestellt wird, ist es sehr wichtig, dass Sie einen strengen Ansatz für die Behandlung threadübergreifender Interaktionen innerhalb Ihrer Anwendungen verwenden. Beispielsweise dürfen Sie nicht mit dem Inhalt eines Formulars innerhalb Ihrer Rückrufprozedur interagieren – wenn Sie das Formular aktualisieren müssen, müssen Sie zum Thread des Formulars zurückkehren, 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 als Ausnahmen in der Rückrufprozedur ausgelöst. Sie müssen die Ausnahme in der Rückrufprozedur behandeln, nicht in der Hauptanwendung. Weitere Informationen zum Behandeln von Ausnahmen in der Rückrufprozedur finden Sie im Beispiel in diesem Thema.

Wenn Sie XML-Daten verwenden ExecuteReader oder BeginExecuteReader darauf zugreifen, gibt SQL Server alle XML-Ergebnisse zurück, die größer als 2.033 Zeichen in mehreren Zeilen mit jeweils 2.033 Zeichen sind. Verwenden Oder ExecuteXmlReader lesen Sie BeginExecuteXmlReader FOR XML-Abfragen, um dieses Verhalten zu vermeiden.

Diese Methode ignoriert die CommandTimeout Eigenschaft.