Udostępnij za pośrednictwem


SqlCommand.BeginExecuteReader Metoda

Definicja

Inicjuje asynchroniczne wykonywanie instrukcji Języka Transact-SQL lub procedury składowanej opisanej przez ten SqlCommandobiekt i pobiera jeden lub więcej zestawów wyników z serwera.

Przeciążenia

BeginExecuteReader()

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym SqlCommandtemacie i pobiera jeden lub więcej zestawów wyników z serwera.

BeginExecuteReader(CommandBehavior)

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej CommandBehavior przy SqlCommand użyciu jednej z wartości.

BeginExecuteReader(AsyncCallback, Object)

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym SqlCommand temacie i pobiera jeden lub więcej zestawów wyników z serwera, biorąc pod uwagę procedurę wywołania zwrotnego i informacje o stanie.

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym SqlCommandtemacie , przy użyciu jednej z CommandBehavior wartości i pobierania co najmniej jednego zestawu wyników z serwera, biorąc pod uwagę procedurę wywołania zwrotnego i informacje o stanie.

BeginExecuteReader()

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym SqlCommandtemacie i pobiera jeden lub więcej zestawów wyników z serwera.

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

Zwraca

Element IAsyncResult , który może służyć do sondowania lub oczekiwania na wyniki albo obu tych wyników. Ta wartość jest również potrzebna w przypadku wywołania EndExecuteReader(IAsyncResult)metody , która zwraca SqlDataReader wystąpienie, które może służyć do pobierania zwróconych wierszy.

Wyjątki

Użyto SqlDbType innego elementu niż Binary lub VarBinary , gdy Value ustawiono wartość Stream. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

-lub-

Użyto SqlDbType innego niż Char, NChar, NVarChar, VarChar lub Xml, gdy Value ustawiono wartość TextReader.

-lub-

Inny SqlDbType niż Xml był używany, gdy Value ustawiono wartość XmlReader.

Wszelkie błędy, które wystąpiły podczas wykonywania tekstu polecenia.

-lub-

Wystąpił limit czasu podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Para name/value "Asynchronous Processing=true" nie została uwzględniona w parametry połączenia definiując połączenie dla tego SqlCommandelementu .

-lub-

Zamknięty SqlConnection lub porzucony podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Wystąpił błąd w StreamXmlReader obiekcie lub TextReader podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

XmlReader Obiekt Streamlub TextReader został zamknięty podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Przykłady

Poniższa aplikacja konsolowa uruchamia proces pobierania czytnika danych asynchronicznie. Czekając na wyniki, ta prosta aplikacja znajduje się w pętli, badając IsCompleted wartość właściwości. Po zakończeniu procesu kod pobiera element SqlDataReader i wyświetla jego zawartość.

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

Uwagi

Metoda BeginExecuteReader uruchamia proces asynchronicznego wykonywania instrukcji Transact-SQL lub procedury składowanej zwracającej wiersze, dzięki czemu inne zadania mogą być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteReader , aby zakończyć operację i pobrać zwrócony SqlDataReader przez polecenie . Metoda BeginExecuteReader jest zwracana natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteReader wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają wykonywanie synchroniczne lub asynchroniczne względem tego samego SqlCommand obiektu. EndExecuteReader Wywołanie polecenia przed wykonaniem polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.

Należy pamiętać, że tekst polecenia i parametry są wysyłane do serwera synchronicznie. Jeśli jest wysyłane duże polecenie lub wiele parametrów, ta metoda może blokować podczas zapisu. Po wysłaniu polecenia metoda zwraca natychmiast bez oczekiwania na odpowiedź z serwera — czyli odczyty są asynchroniczne. Mimo że wykonywanie poleceń jest asynchroniczne, pobieranie wartości jest nadal synchroniczne. Oznacza to, że wywołania mogą blokować Read , jeśli wymagana jest więcej danych i bloki operacji odczytu sieci bazowej.

Ponieważ to przeciążenie nie obsługuje procedury wywołania zwrotnego, deweloperzy muszą sondować, czy polecenie zostało ukończone, używając właściwości zwracanej przez BeginExecuteReader metodę, lub poczekać na ukończenie co najmniej jednego polecenia przy użyciu AsyncWaitHandleIsCompleted właściwości zwróconej IAsyncResult.IAsyncResult

Jeśli używasz ExecuteReader lub BeginExecuteReader uzyskujesz dostęp do danych XML, SQL Server zwróci wszystkie wyniki XML większe niż 2033 znaki w wielu wierszach o długości 2033 znaków. Aby uniknąć tego zachowania, użyj ExecuteXmlReader polecenia lub BeginExecuteXmlReader odczytu dla zapytań XML.

Ta metoda ignoruje CommandTimeout właściwość .

Zobacz też

Dotyczy

BeginExecuteReader(CommandBehavior)

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej CommandBehavior przy SqlCommand użyciu jednej z wartości.

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

Parametry

behavior
CommandBehavior

CommandBehavior Jedna z wartości wskazująca opcje wykonywania instrukcji i pobierania danych.

Zwraca

Element IAsyncResult , który może służyć do sondowania, oczekiwania na wyniki lub obu. Ta wartość jest również potrzebna w przypadku wywołania EndExecuteReader(IAsyncResult)metody , która zwraca SqlDataReader wystąpienie, które może służyć do pobierania zwróconych wierszy.

Wyjątki

Użyto SqlDbType innego elementu niż Binary lub VarBinary , gdy Value ustawiono wartość Stream. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

-lub-

Użyto SqlDbType innego niż Char, NChar, NVarChar, VarChar lub Xml, gdy Value ustawiono wartość TextReader.

-lub-

Inny SqlDbType niż Xml był używany, gdy Value ustawiono wartość XmlReader.

Wszelkie błędy, które wystąpiły podczas wykonywania tekstu polecenia.

-lub-

Wystąpił limit czasu podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Para name/value "Asynchronous Processing=true" nie została uwzględniona w parametry połączenia definiując połączenie dla tego SqlCommandelementu .

-lub-

Zamknięty SqlConnection lub porzucony podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Wystąpił błąd w StreamXmlReader obiekcie lub TextReader podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

XmlReader Obiekt Streamlub TextReader został zamknięty podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Przykłady

Poniższa aplikacja konsolowa uruchamia proces pobierania czytnika danych asynchronicznie. Czekając na wyniki, ta prosta aplikacja znajduje się w pętli, badając IsCompleted wartość właściwości. Po zakończeniu procesu kod pobiera element SqlDataReader i wyświetla jego zawartość.

Ten przykład przekazuje CommandBehavior.CloseConnection również wartości i CommandBehavior.SingleRow w parametrze zachowania, powodując zamknięcie połączenia z zwróconym SqlDataReader wierszem i zoptymalizowanie pod kątem pojedynczego wyniku wiersza.

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

Uwagi

Metoda BeginExecuteReader uruchamia proces asynchronicznego wykonywania instrukcji Transact-SQL lub procedury składowanej zwracającej wiersze, dzięki czemu inne zadania mogą być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteReader , aby zakończyć operację i pobrać zwrócony SqlDataReader przez polecenie . Metoda BeginExecuteReader jest zwracana natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteReader wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają wykonywanie synchroniczne lub asynchroniczne względem tego samego SqlCommand obiektu. EndExecuteReader Wywołanie polecenia przed wykonaniem polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.

Parametr behavior umożliwia określenie opcji, które kontrolują zachowanie polecenia i jego połączenia. Te wartości można łączyć razem (przy użyciu operatora języka OR programowania); zazwyczaj deweloperzy używają CommandBehavior.CloseConnection wartości , aby upewnić się, że połączenie jest zamknięte przez środowisko uruchomieniowe po SqlDataReader zamknięciu.

Należy pamiętać, że tekst polecenia i parametry są wysyłane do serwera synchronicznie. Jeśli jest wysyłane duże polecenie lub wiele parametrów, ta metoda może blokować podczas zapisu. Po wysłaniu polecenia metoda zwraca natychmiast bez oczekiwania na odpowiedź z serwera — czyli odczyty są asynchroniczne. Mimo że wykonywanie poleceń jest asynchroniczne, pobieranie wartości jest nadal synchroniczne. Oznacza to, że wywołania mogą blokować Read , jeśli wymagana jest więcej danych i bloki operacji odczytu sieci bazowej.

Ponieważ to przeciążenie nie obsługuje procedury wywołania zwrotnego, deweloperzy muszą sondować, czy polecenie zostało ukończone, używając właściwości zwracanej przez BeginExecuteNonQuery metodę, lub poczekać na ukończenie co najmniej jednego polecenia przy użyciu AsyncWaitHandleIsCompleted właściwości zwróconej IAsyncResult.IAsyncResult

Jeśli używasz ExecuteReader danych XML lub BeginExecuteReader uzyskujesz dostęp do nich, SQL Server zwraca wyniki XML większe niż 2033 znaki w wielu wierszach o długości 2033 znaków. Aby uniknąć tego zachowania, użyj ExecuteXmlReader polecenia lub BeginExecuteXmlReader odczytu dla zapytań XML.

Ta metoda ignoruje CommandTimeout właściwość .

Zobacz też

Dotyczy

BeginExecuteReader(AsyncCallback, Object)

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym SqlCommand temacie i pobiera jeden lub więcej zestawów wyników z serwera, biorąc pod uwagę procedurę wywołania zwrotnego i informacje o stanie.

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

Parametry

callback
AsyncCallback

Delegat AsyncCallback wywoływany po zakończeniu wykonywania polecenia. Przekaż null (Nothing w programie Microsoft Visual Basic), aby wskazać, że nie jest wymagane wywołanie zwrotne.

stateObject
Object

Obiekt stanu zdefiniowany przez użytkownika przekazywany do procedury wywołania zwrotnego. Pobierz ten obiekt z procedury wywołania zwrotnego przy użyciu AsyncState właściwości .

Zwraca

Element IAsyncResult , który może służyć do sondowania, oczekiwania na wyniki lub obu. Ta wartość jest również potrzebna w przypadku wywołania EndExecuteReader(IAsyncResult)metody , która zwraca SqlDataReader wystąpienie, które może służyć do pobierania zwróconych wierszy.

Wyjątki

Użyto SqlDbType innego elementu niż Binary lub VarBinary , gdy Value ustawiono wartość Stream. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

-lub-

Użyto SqlDbType innego niż Char, NChar, NVarChar, VarChar lub Xml, gdy Value ustawiono wartość TextReader.

-lub-

Inny SqlDbType niż Xml był używany, gdy Value ustawiono wartość XmlReader.

Wszelkie błędy, które wystąpiły podczas wykonywania tekstu polecenia.

-lub-

Wystąpił limit czasu podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Para name/value "Asynchronous Processing=true" nie została uwzględniona w parametry połączenia definiując połączenie dla tego SqlCommandelementu .

-lub-

Zamknięty SqlConnection lub porzucony podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Wystąpił błąd w StreamXmlReader obiekcie lub TextReader podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

XmlReader Obiekt Streamlub TextReader został zamknięty podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Przykłady

Poniższa aplikacja systemu Windows demonstruje użycie BeginExecuteReader metody , wykonując instrukcję Języka Transact-SQL, która zawiera opóźnienie kilku sekund (emulując długotrwałe polecenie). Ponieważ przykład wykonuje polecenie asynchronicznie, formularz pozostaje dynamiczny podczas oczekiwania na wyniki. Ten przykład przekazuje obiekt wykonujący SqlCommand jako stateObject parametr. Dzięki temu można łatwo pobrać SqlCommand obiekt z procedury wywołania zwrotnego, aby kod mógł wywołać metodę odpowiadającą początkowemu wywołaniu EndExecuteReader .BeginExecuteReader

W tym przykładzie pokazano wiele ważnych technik. Obejmuje to wywołanie metody, która wchodzi w interakcję z formularzem z oddzielnego wątku. Ponadto w tym przykładzie pokazano, jak należy zablokować użytkownikom wykonywanie polecenia wiele razy jednocześnie i jak należy się upewnić, że formularz nie jest zamykany przed wywołaniem procedury wywołania zwrotnego.

Aby skonfigurować ten przykład, utwórz nową aplikację systemu Windows. Umieść kontrolkę, kontrolkę ButtonDataGridView i kontrolkę Label w formularzu (akceptując domyślną nazwę dla każdej kontrolki). Dodaj następujący kod do klasy formularza, modyfikując parametry połączenia zgodnie z potrzebami dla środowiska.

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

Uwagi

Metoda BeginExecuteReader uruchamia proces asynchronicznego wykonywania instrukcji Transact-SQL lub procedury składowanej zwracającej wiersze, dzięki czemu inne zadania mogą być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteReader , aby zakończyć operację i pobrać zwrócony SqlDataReader przez polecenie . Metoda BeginExecuteReader jest zwracana natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteReader wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają wykonywanie synchroniczne lub asynchroniczne względem tego samego SqlCommand obiektu. EndExecuteReader Wywołanie polecenia przed zakończeniem wykonywania polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.

Parametr callback umożliwia określenie delegata AsyncCallback , który jest wywoływany po zakończeniu instrukcji. Możesz wywołać metodę EndExecuteReader z tej procedury delegata lub z dowolnej innej lokalizacji w aplikacji. Ponadto można przekazać dowolny obiekt w parametrze stateObject , a procedura wywołania zwrotnego może pobrać te informacje przy użyciu AsyncState właściwości .

Należy pamiętać, że tekst polecenia i parametry są wysyłane do serwera synchronicznie. Jeśli jest wysyłane duże polecenie lub wiele parametrów, ta metoda może blokować podczas zapisu. Po wysłaniu polecenia metoda zwraca natychmiast bez oczekiwania na odpowiedź z serwera — czyli odczyty są asynchroniczne. Mimo że wykonywanie poleceń jest asynchroniczne, pobieranie wartości jest nadal synchroniczne. Oznacza to, że wywołania mogą blokować Read , jeśli wymagana jest więcej danych i bloki operacji odczytu sieci bazowej.

Ponieważ procedura wywołania zwrotnego jest wykonywana z poziomu wątku w tle dostarczonego przez środowisko uruchomieniowe platformy Microsoft .NET, bardzo ważne jest, aby zastosować rygorystyczne podejście do obsługi interakcji między wątkami z poziomu aplikacji. Na przykład nie można wchodzić w interakcje z zawartością formularza z poziomu procedury wywołania zwrotnego; jeśli musisz zaktualizować formularz, musisz wrócić do wątku formularza, aby wykonać swoją pracę. W przykładzie w tym temacie pokazano to zachowanie.

Wszystkie błędy występujące podczas wykonywania operacji są zgłaszane jako wyjątki w procedurze wywołania zwrotnego. Należy obsłużyć wyjątek w procedurze wywołania zwrotnego, a nie w aplikacji głównej. Zobacz przykład w tym temacie, aby uzyskać dodatkowe informacje na temat obsługi wyjątków w procedurze wywołania zwrotnego.

Jeśli używasz ExecuteReader danych XML lub BeginExecuteReader uzyskujesz dostęp do nich, SQL Server zwraca wyniki XML większe niż 2033 znaki w wielu wierszach o długości 2033 znaków. Aby uniknąć tego zachowania, użyj ExecuteXmlReader polecenia lub BeginExecuteXmlReader odczytu dla zapytań XML.

Ta metoda ignoruje CommandTimeout właściwość .

Zobacz też

Dotyczy

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Inicjuje asynchroniczne wykonywanie instrukcji Języka Transact-SQL lub procedury składowanej opisanej w tym SqlCommandobiekcie , przy użyciu jednej z wartości i pobieranie co najmniej CommandBehavior jednego zestawu wyników z serwera, biorąc pod uwagę procedurę wywołania zwrotnego i informacje o stanie.

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

Parametry

callback
AsyncCallback

Delegat AsyncCallback wywoływany po zakończeniu wykonywania polecenia. Przekaż null (Nothing w programie Microsoft Visual Basic), aby wskazać, że nie jest wymagane wywołanie zwrotne.

stateObject
Object

Obiekt stanu zdefiniowany przez użytkownika przekazywany do procedury wywołania zwrotnego. Pobierz ten obiekt z procedury wywołania zwrotnego przy użyciu AsyncState właściwości .

behavior
CommandBehavior

CommandBehavior Jedna z wartości wskazująca opcje wykonywania instrukcji i pobierania danych.

Zwraca

Element IAsyncResult , który może służyć do sondowania lub oczekiwania na wyniki albo obu. Ta wartość jest również potrzebna w przypadku wywołania EndExecuteReader(IAsyncResult)metody , która zwraca SqlDataReader wystąpienie, które może służyć do pobierania zwracanych wierszy.

Wyjątki

Użyto SqlDbType innego elementu niż Binary lub VarBinary , gdy Value ustawiono wartość Stream. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

-lub-

Użyto SqlDbType innego niż Char, NChar, NVarChar, VarChar lub Xml, gdy Value ustawiono wartość TextReader.

-lub-

Inny SqlDbType niż Xml był używany, gdy Value ustawiono wartość XmlReader.

Wszelkie błędy, które wystąpiły podczas wykonywania tekstu polecenia.

-lub-

Wystąpił limit czasu podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Para name/value "Asynchronous Processing=true" nie została uwzględniona w parametry połączenia definiując połączenie dla tego SqlCommandelementu .

-lub-

Zamknięty SqlConnection lub porzucony podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Wystąpił błąd w StreamXmlReader obiekcie lub TextReader podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

XmlReader Obiekt Streamlub TextReader został zamknięty podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego sqlClient.

Przykłady

Poniższa aplikacja systemu Windows demonstruje użycie BeginExecuteReader metody , wykonując instrukcję Języka Transact-SQL, która zawiera opóźnienie kilku sekund (emulując długotrwałe polecenie). Ponieważ przykład wykonuje polecenie asynchronicznie, formularz pozostaje dynamiczny podczas oczekiwania na wyniki. Ten przykład przekazuje obiekt wykonujący SqlCommand jako stateObject parametr. Dzięki temu można łatwo pobrać SqlCommand obiekt z procedury wywołania zwrotnego, aby kod mógł wywołać metodę odpowiadającą początkowemu wywołaniu EndExecuteReader .BeginExecuteReader

W tym przykładzie pokazano wiele ważnych technik. Obejmuje to wywołanie metody, która wchodzi w interakcję z formularzem z oddzielnego wątku. Ponadto w tym przykładzie pokazano, jak należy zablokować użytkownikom wykonywanie polecenia wiele razy jednocześnie i jak należy się upewnić, że formularz nie jest zamykany przed wywołaniem procedury wywołania zwrotnego.

Aby skonfigurować ten przykład, utwórz nową aplikację systemu Windows. Umieść kontrolkę, kontrolkę ButtonDataGridView i kontrolkę Label w formularzu (akceptując domyślną nazwę dla każdej kontrolki). Dodaj następujący kod do klasy formularza, modyfikując parametry połączenia zgodnie z potrzebami dla środowiska.

Ten przykład przekazuje CommandBehavior.CloseConnection wartość w parametrze behavior , co powoduje automatyczne zamknięcie połączenia po SqlDataReader jego zamknięciu.

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

Uwagi

Metoda BeginExecuteReader uruchamia proces asynchronicznego wykonywania instrukcji Transact-SQL lub procedury składowanej zwracającej wiersze, dzięki czemu inne zadania mogą być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteReader , aby zakończyć operację i pobrać zwrócony SqlDataReader przez polecenie . Metoda BeginExecuteReader jest zwracana natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteReader wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają wykonywanie synchroniczne lub asynchroniczne względem tego samego SqlCommand obiektu. EndExecuteReader Wywołanie polecenia przed wykonaniem polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.

Parametr callback umożliwia określenie delegata AsyncCallback , który jest wywoływany po zakończeniu instrukcji. Możesz wywołać metodę EndExecuteReader z tej procedury delegata lub z dowolnej innej lokalizacji w aplikacji. Ponadto można przekazać dowolny obiekt w parametrze stateObject , a procedura wywołania zwrotnego może pobrać te informacje przy użyciu AsyncState właściwości .

Parametr behavior umożliwia określenie opcji, które kontrolują zachowanie polecenia i jego połączenia. Te wartości można łączyć razem (przy użyciu operatora języka Or programowania); zazwyczaj deweloperzy używają CloseConnection wartości , aby upewnić się, że połączenie jest zamknięte przez środowisko uruchomieniowe po SqlDataReader zamknięciu. Deweloperzy mogą również zoptymalizować zachowanie obiektu SqlDataReader , określając SingleRow wartość, gdy wiadomo z wyprzedzeniem, że instrukcja Transact-SQL lub procedura składowana zwraca tylko jeden wiersz.

Należy pamiętać, że tekst polecenia i parametry są wysyłane do serwera synchronicznie. Jeśli jest wysyłane duże polecenie lub wiele parametrów, ta metoda może blokować podczas zapisu. Po wysłaniu polecenia metoda zwraca natychmiast bez oczekiwania na odpowiedź z serwera — czyli odczyty są asynchroniczne. Mimo że wykonywanie poleceń jest asynchroniczne, pobieranie wartości jest nadal synchroniczne. Oznacza to, że wywołania mogą blokować Read , jeśli wymagana jest więcej danych i bloki operacji odczytu sieci bazowej.

Ponieważ procedura wywołania zwrotnego jest wykonywana z poziomu wątku w tle dostarczonego przez środowisko uruchomieniowe języka wspólnego platformy Microsoft .NET, bardzo ważne jest, aby zastosować rygorystyczne podejście do obsługi interakcji między wątkami z poziomu aplikacji. Na przykład nie można wchodzić w interakcję z zawartością formularza z poziomu procedury wywołania zwrotnego — jeśli musisz zaktualizować formularz, musisz wrócić do wątku formularza, aby wykonać pracę. W przykładzie w tym temacie pokazano to zachowanie.

Wszystkie błędy występujące podczas wykonywania operacji są zgłaszane jako wyjątki w procedurze wywołania zwrotnego. Należy obsłużyć wyjątek w procedurze wywołania zwrotnego, a nie w głównej aplikacji. Zobacz przykład w tym temacie, aby uzyskać dodatkowe informacje na temat obsługi wyjątków w procedurze wywołania zwrotnego.

Jeśli używasz ExecuteReader funkcji lub BeginExecuteReader do uzyskiwania dostępu do danych XML, SQL Server zwróci wyniki XML większe niż 2033 znaków w wielu wierszach o długości 2033 znaków. Aby uniknąć tego zachowania, użyj polecenia ExecuteXmlReader lub BeginExecuteXmlReader do odczytu dla zapytań XML.

Ta metoda ignoruje CommandTimeout właściwość .

Zobacz też

Dotyczy