SqlCommand.BeginExecuteReader Methode

Referenz

Definition

Namespace:: System.Data.SqlClient

Assembly:: System.Data.SqlClient.dll

Assembly:: System.Data.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und ruft ein oder mehrere Resultsets vom Server ab.

Überlädt

BeginExecuteReader()	Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und ruft ein oder mehrere Resultsets vom Server ab.
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 ruft ein oder mehrere Resultsets vom Server ab, wenn eine Rückrufprozedur und Zustandsinformationen verfügbar sind.
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)	Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, wobei einer der `CommandBehavior`-Werte verwendet wird und ein oder mehrere Resultsets vom Server abgerufen werden, wenn eine Rückrufprozedur und Zustandsinformationen verfügbar sind.

BeginExecuteReader()

Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und ruft ein oder mehrere Resultsets vom Server ab.

public:
 IAsyncResult ^ BeginExecuteReader();

public IAsyncResult BeginExecuteReader ();

member this.BeginExecuteReader : unit -> IAsyncResult

Public Function BeginExecuteReader () As IAsyncResult

Gibt zurück

IAsyncResult

Ein IAsyncResult zum Abfragen von Ergebnissen und/oder Warten auf Ergebnisse. Dieser Wert wird auch zum Aufrufen von EndExecuteReader(IAsyncResult) benötigt, die eine SqlDataReader-Instanz zurückgibt, mit der die zurückgegebenen Zeilen abgerufen werden können.

Ausnahmen

InvalidCastException

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

- oder -

Eine SqlDbType andere als Char, NChar, NVarChar, VarChar oder Xml wurde verwendet, wenn Value festgelegt TextReaderwurde.

- oder -

Es wurde ein anderer SqlDbType als Xml verwendet, als Value auf XmlReader festgelegt wurde.

SqlException

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

InvalidOperationException

Das Name-Wert-Paar "Asynchronous Processing=true" war nicht in der Verbindungszeichenfolge enthalten, mit der die Verbindung für diesen SqlCommand definiert wird.

- oder -

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

IOException

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

ObjectDisposedException

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 warten, befindet sich diese einfache Anwendung in einer Schleife und untersucht den IsCompleted Eigenschaftswert. Sobald der Prozess abgeschlossen ist, ruft der Code die SqlDataReader Inhalte ab und zeigt den Inhalt an.

using System.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} ", 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.

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

Imports System.Data.SqlClient

Module Module1
    Sub 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.
        Dim commandText As String = _
         "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()
    End Sub

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

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

                connection.Open()
                Dim result As IAsyncResult = command.BeginExecuteReader()

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

                ' Once the IAsyncResult object signals that it is done
                ' waiting for results, you can retrieve the results.
                Using reader As SqlDataReader = command.EndExecuteReader(result)
                    DisplayResults(reader)
                End Using
            Catch ex As SqlException
                Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message)
            Catch ex As InvalidOperationException
                Console.WriteLine("Error: {0}", ex.Message)
            Catch ex As Exception
                ' You might want to pass these errors
                ' back out to the caller.
                Console.WriteLine("Error: {0}", ex.Message)
            End Try
        End Using
    End Sub

    Private Sub DisplayResults(ByVal reader As SqlDataReader)
        ' Display the data within the reader.
        While reader.Read()
            ' Display all the columns.
            For i As Integer = 0 To reader.FieldCount - 1
                Console.Write("{0} ", reader.GetValue(i))
            Next
            Console.WriteLine()
        End While
    End Sub

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

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

Hinweise

Die 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 den SqlDataReader vom Befehl zurückgegebenen Abruf abzurufen. Die BeginExecuteReader Methode gibt sofort zurück, 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.

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 von Schreibvorgängen blockiert werden. Nachdem der Befehl gesendet wurde, gibt die Methode sofort zurück, ohne auf eine Antwort des Servers zu warten– das heißt, Lesevorgänge sind asynchron. Obwohl die Ausführung von Befehlen asynchron ist, ist die Wertabrufung weiterhin 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 ermitteln, ob der Befehl abgeschlossen wurde, indem die IsCompleted Eigenschaft der IAsyncResult von der BeginExecuteReader Methode zurückgegebenen Eigenschaft verwendet wird, oder warten Sie, bis eine oder mehrere Befehle mit der AsyncWaitHandle Eigenschaft der zurückgegebenen IAsyncResultBefehle abgeschlossen wurden.

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

Diese Methode ignoriert die CommandTimeout Eigenschaft.

Siehe auch

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

IAsyncResult

Ein IAsyncResult zum Abfragen von Ergebnissen und/oder als Warteschleife. Dieser Wert wird auch zum Aufrufen von EndExecuteReader(IAsyncResult) benötigt, das eine SqlDataReader-Instanz zurückgibt, mit der die zurückgegebenen Zeilen abgerufen werden können.

Ausnahmen

InvalidCastException

- oder -

Eine SqlDbType andere als Char, NChar, NVarChar, VarChar oder Xml wurde verwendet, wenn Value festgelegt TextReaderwurde.

- oder -

Es wurde ein anderer SqlDbType als Xml verwendet, als Value auf XmlReader festgelegt wurde.

SqlException

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

InvalidOperationException

Das Name-Wert-Paar "Asynchronous Processing=true" war nicht in der Verbindungszeichenfolge enthalten, mit der die Verbindung für diesen SqlCommand definiert wird.

- oder -

IOException

ObjectDisposedException

Beispiele

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

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

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

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

Imports System.Data.SqlClient

Module Module1
    Sub 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.
        Dim commandText As String = _
         "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()
    End Sub

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

        ' Given command text and connection string, asynchronously execute
        ' the specified command against the connection. For this example,
        ' the code displays an indicator as it is working, verifying the 
        ' asynchronous behavior. 
        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. 
            Dim connection As New SqlConnection(connectionString)
            Dim command As New SqlCommand(commandText, connection)

            connection.Open()
            Dim result As IAsyncResult = _
              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.
            Dim count As Integer = 0
            While Not result.IsCompleted
                count += 1
                Console.WriteLine("Waiting ({0})", count)
                ' Wait for 1/10 second, so the counter
                ' does not consume all available resources 
                ' on the main thread.
                Threading.Thread.Sleep(100)
            End While

            ' The "using" statement closes the SqlDataReader when it is 
            ' done executing.
            Using reader As SqlDataReader = command.EndExecuteReader(result)
                DisplayResults(reader)
            End Using
        Catch ex As SqlException
            Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message)
        Catch ex As InvalidOperationException
            Console.WriteLine("Error: {0}", ex.Message)
        Catch ex As Exception
            ' You might want to pass these errors
            ' back out to the caller.
            Console.WriteLine("Error: {0}", ex.Message)
        End Try
    End Sub

    Private Sub DisplayResults(ByVal reader As SqlDataReader)
        ' Display the data within the reader.
        While reader.Read()
            ' Display all the columns. 
            For i As Integer = 0 To reader.FieldCount - 1
                Console.Write("{0} ", reader.GetValue(i))
            Next
            Console.WriteLine()
        End While
    End Sub

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

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

Hinweise

Die 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. Wenn die Anweisung abgeschlossen ist, müssen Entwickler die EndExecuteReader Methode aufrufen, um den Vorgang abzuschließen und den SqlDataReader vom Befehl zurückgegebenen Abrufen abzurufen. Die BeginExecuteReader Methode gibt sofort zurück, aber bis der Code den entsprechenden EndExecuteReader Methodenaufruf ausführt, darf es keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung mit demselben SqlCommand Objekt starten. Das Aufrufen der EndExecuteReader 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, wird die Methode sofort zurückgegeben, ohne auf eine Antwort aus dem Server zu warten. Dies ist asynchron. Obwohl die Befehlsausführung asynchron ist, ist die Wertabrufung weiterhin 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 ermitteln, ob der Befehl abgeschlossen ist, indem er die IsCompleted Eigenschaft der IAsyncResult von der BeginExecuteNonQuery Methode zurückgegebenen Eigenschaft verwendet, oder warten Sie auf den Abschluss eines oder mehrerer Befehle mithilfe AsyncWaitHandle der Eigenschaft des zurückgegebenen IAsyncResultBefehls.

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

Diese Methode ignoriert die CommandTimeout Eigenschaft.

Siehe auch

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 ruft ein oder mehrere Resultsets vom Server ab, wenn eine Rückrufprozedur und Zustandsinformationen verfügbar sind.

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. Übergeben Sie null (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

IAsyncResult

Ein IAsyncResult zum Abfragen von Ergebnissen oder als Warteschleife. Dieser Wert wird auch zum Aufrufen von EndExecuteReader(IAsyncResult) benötigt, das eine SqlDataReader-Instanz zurückgibt, mit der die zurückgegebenen Zeilen abgerufen werden können.

Ausnahmen

InvalidCastException

- oder -

Eine SqlDbType andere als Char, NChar, NVarChar, VarChar oder Xml wurde verwendet, wenn Value festgelegt TextReaderwurde.

- oder -

Es wurde ein anderer SqlDbType als Xml verwendet, als Value auf XmlReader festgelegt wurde.

SqlException

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

InvalidOperationException

Das Name-Wert-Paar "Asynchronous Processing=true" war nicht in der Verbindungszeichenfolge enthalten, mit der die Verbindung für diesen SqlCommand definiert wird.

- oder -

IOException

ObjectDisposedException

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 beim Warten auf die Ergebnisse reaktionsfähig. In diesem Beispiel wird das ausführende SqlCommand Objekt als stateObject Parameter übergeben. Dadurch SqlCommand kann das 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 aus einem separaten Thread interagiert. Darüber hinaus veranschaulicht dieses Beispiel, wie Sie Benutzern das Ausführen eines Befehls mehrmals gleichzeitig blockieren müssen 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 Steuerelement, ein DataGridView Steuerelement und ein Label Button Steuerelement im Formular (akzeptiert den Standardnamen für jedes Steuerelement). Fügen Sie den folgenden Code zur Klasse des Formulars hinzu, indem Sie die Verbindungszeichenfolge nach Bedarf für Ihre Umgebung ändern.

using System.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 = false;

        // Because the overloaded version of BeginExecuteReader
        // demonstrated here does not allow you to have the connection
        // closed automatically, this example maintains the
        // connection object externally, so that it is available for closing.
        private SqlConnection connection = null;

        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
            {
                // Do not forget to close the connection, as well.
                if (reader != null)
                {
                    reader.Close();
                }
                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;
                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.

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

        private void 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
                {
                    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);
                }
                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;
            }
        }
    }
}

Imports System.Data.SqlClient

Public Class Form1
    ' 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 Sub FillGridDelegate(ByVal reader As SqlDataReader)

    ' You need this delegate to update the status bar.
    Private Delegate Sub DisplayStatusDelegate(ByVal Text As String)

    ' This flag ensures that the user does not attempt
    ' to restart the command or close the form while the 
    ' asynchronous command is executing.
    Private isExecuting As Boolean

    ' Because the overloaded version of BeginExecuteReader
    ' demonstrated here does not allow you to have the connection
    ' closed automatically, this example maintains the 
    ' connection object externally, so that it is available for closing.
    Private connection As SqlConnection

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

    Private Sub FillGrid(ByVal reader As SqlDataReader)
        Try
            Dim table As New DataTable
            table.Load(reader)
            Me.DataGridView1.DataSource = table
            DisplayStatus("Ready")

        Catch ex As Exception
            ' 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
            ' Do not forget to close the connection, as well.
            If Not reader Is Nothing Then
                reader.Close()
            End If
            If Not connection Is Nothing Then
                connection.Close()
            End If
        End Try
    End Sub

    Private Sub HandleCallback(ByVal result As IAsyncResult)
        Try
            ' Retrieve the original command object, passed
            ' to this procedure in the AsyncState property
            ' of the IAsyncResult parameter.
            Dim command As SqlCommand = CType(result.AsyncState, SqlCommand)
            Dim reader As SqlDataReader = 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. 
            Dim del As New FillGridDelegate(AddressOf FillGrid)
            Me.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 ex As Exception
            ' Because you are now running code in a separate thread, 
            ' if you do not handle the exception here, none of your other
            ' code catches the exception. Because 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:
            Me.Invoke(New DisplayStatusDelegate(AddressOf DisplayStatus), _
             "Error: " & ex.Message)
        Finally
            isExecuting = False
        End Try
    End Sub

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

        ' If you do not include the Asynchronous Processing=true name/value pair,
        ' you wo not be able to execute the command asynchronously.

        Return "Data Source=(local);Integrated Security=true;" & _
        "Initial Catalog=AdventureWorks; Asynchronous Processing=true"
    End Function

    Private Sub Button1_Click(ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button1.Click
        If isExecuting Then
            MessageBox.Show(Me, _
                "Already executing. Please wait until the current query " & _
                "has completed.")
        Else
            Dim command As SqlCommand
            Try
                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.
                Dim callback As New AsyncCallback(AddressOf HandleCallback)
                command.BeginExecuteReader(callback, command)

            Catch ex As Exception
                DisplayStatus("Error: " & ex.Message)
                If connection IsNot Nothing Then
                    connection.Close()
                End If
            End Try
        End If
    End Sub

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

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. Wenn die Anweisung abgeschlossen ist, müssen Entwickler die EndExecuteReader Methode aufrufen, um den Vorgang abzuschließen und den SqlDataReader vom Befehl zurückgegebenen Abrufen abzurufen. Die BeginExecuteReader Methode gibt sofort zurück, aber bis der Code den entsprechenden EndExecuteReader Methodenaufruf ausführt, darf es keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung mit demselben SqlCommand Objekt starten. Das Aufrufen der EndExecuteReader Ausführung des Befehls führt dazu, dass das SqlCommand Objekt blockiert wird, bis die Ausführung abgeschlossen ist.

Mit dem callback Parameter können Sie einen AsyncCallback Stellvertretung angeben, der aufgerufen wird, wenn die Anweisung abgeschlossen ist. Sie können die EndExecuteReader Methode aus dieser Stellvertretungsprozedur oder aus einem anderen Speicherort in Ihrer Anwendung aufrufen. Darüber hinaus können Sie jedes Objekt im Parameter übergeben, und Ihre Rückrufprozedur kann diese Informationen mithilfe der stateObject 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 der Schreibvorgänge blockiert werden. Nachdem der Befehl gesendet wurde, wird die Methode sofort zurückgegeben, ohne auf eine Antwort aus dem Server zu warten. Dies ist asynchron. Obwohl die Befehlsausführung asynchron ist, ist die Wertabrufung weiterhin 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-Runtime bereitgestellt wird, ist es sehr wichtig, dass Sie einen strengen Ansatz zum Behandeln von Threadinteraktionen aus Ihren Anwendungen ausführen. 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 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 zur Behandlung von Ausnahmen in der Rückrufprozedur finden Sie im Beispiel in diesem Thema.

Diese Methode ignoriert die CommandTimeout Eigenschaft.

Siehe auch

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, wobei einer der CommandBehavior-Werte verwendet wird und ein oder mehrere Resultsets vom Server abgerufen werden, wenn eine Rückrufprozedur und Zustandsinformationen verfügbar sind.

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

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

IAsyncResult

Ein IAsyncResult, das zum Abfragen von Ergebnissen und/oder als Warteschleife verwendet werden kann. Dieser Wert wird auch beim Aufrufen von EndExecuteReader(IAsyncResult) benötigt, das eine SqlDataReader-Instanz zurückgibt, mit der die zurückgegebenen Zeilen abgerufen werden können.

Ausnahmen

InvalidCastException

- oder -

Eine SqlDbType andere als Char, NChar, NVarChar, VarChar oder Xml wurde verwendet, wenn Value festgelegt TextReaderwurde.

- oder -

Es wurde ein anderer SqlDbType als Xml verwendet, als Value auf XmlReader festgelegt wurde.

SqlException

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

InvalidOperationException

Das Name-Wert-Paar "Asynchronous Processing=true" war nicht in der Verbindungszeichenfolge enthalten, mit der die Verbindung für diesen SqlCommand definiert wird.

- oder -

IOException

ObjectDisposedException

Beispiele

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.

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

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

        private void 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;
            }
        }
    }
}

Imports System.Data.SqlClient

Public Class Form1
    ' Add this code to the form's class:
    ' You 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 Sub FillGridDelegate(ByVal reader As SqlDataReader)

    ' You need this delegate to update the status bar.
    Private Delegate Sub DisplayStatusDelegate(ByVal Text As String)

    ' This flag ensures that the user does not attempt
    ' to restart the command or close the form while the 
    ' asynchronous command is executing.
    Private isExecuting As Boolean

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

    Private Sub FillGrid(ByVal reader As SqlDataReader)
        Try
            Dim table As New DataTable
            table.Load(reader)
            Me.DataGridView1.DataSource = table
            DisplayStatus("Ready")

        Catch ex As Exception
            ' 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 IsNot Nothing Then
                reader.Close()
            End If
        End Try
    End Sub

    Private Sub HandleCallback(ByVal result As IAsyncResult)
        Try
            ' Retrieve the original command object, passed
            ' to this procedure in the AsyncState property
            ' of the IAsyncResult parameter.
            Dim command As SqlCommand = CType(result.AsyncState, SqlCommand)
            Dim reader As SqlDataReader = 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. 
            Dim del As New FillGridDelegate(AddressOf FillGrid)
            Me.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 ex As Exception
            ' Because you are now running code in a separate thread, 
            ' if you do not handle the exception here, none of your other
            ' code catches the exception. Because 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:
            Me.Invoke(New DisplayStatusDelegate(AddressOf DisplayStatus), _
             "Error: " & ex.Message)
        Finally
            isExecuting = False
        End Try
    End Sub

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

        ' If you do not include the Asynchronous Processing=true name/value pair,
        ' you wo not be able to execute the command asynchronously.

        Return "Data Source=(local);Integrated Security=true;" & _
        "Initial Catalog=AdventureWorks; Asynchronous Processing=true"
    End Function

    Private Sub Button1_Click(ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button1.Click
        If isExecuting Then
            MessageBox.Show(Me, "Already executing. Please wait until the current query " & _
             "has completed.")
        Else
            Dim connection As SqlConnection
            Dim command As SqlCommand
            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.
                Dim callback As New AsyncCallback(AddressOf HandleCallback)
                command.BeginExecuteReader(callback, command, _
                  CommandBehavior.CloseConnection)

            Catch ex As Exception
                DisplayStatus("Error: " & ex.Message)
                If connection IsNot Nothing Then
                    connection.Close()
                End If
            End Try
        End If
    End Sub

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

Hinweise

Mit dem behavior Parameter können Sie Optionen angeben, die das Verhalten des Befehls und deren Verbindung steuern. Diese Werte können zusammen kombiniert werden (mithilfe des Operators Or der Programmiersprache); im Allgemeinen verwenden Entwickler den CloseConnection Wert, um sicherzustellen, dass die Verbindung durch die Laufzeit geschlossen wird, wenn dies SqlDataReader geschlossen wird. Entwickler können auch das Verhalten der SqlDataReader Datei 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, wird die Methode sofort zurückgegeben, ohne auf eine Antwort aus dem Server zu warten. Dies ist asynchron. Obwohl die Befehlsausführung asynchron ist, ist die Wertabrufung weiterhin 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 gängigen Sprachlaufzeit von Microsoft .NET bereitgestellt wird, ist es sehr wichtig, dass Sie einen strengen Ansatz zum Behandeln von Threadinteraktionen innerhalb Ihrer Anwendungen ergreifen. Sie müssen z. B. nicht mit dem Inhalt eines Formulars innerhalb Ihrer Rückrufprozedur interagieren– sollten 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.

Wenn Sie XML-Daten verwenden ExecuteReader oder BeginExecuteReader zugreifen möchten, gibt SQL Server alle XML-Ergebnisse zurück, die größer als 2.033 Zeichen in der Länge in mehreren Zeilen von 2.033 Zeichen sind. Um dieses Verhalten zu vermeiden, verwenden ExecuteXmlReader oder BeginExecuteXmlReader lesen Sie FOR XML-Abfragen.

Diese Methode ignoriert die CommandTimeout Eigenschaft.

Siehe auch

Gilt für: