SqlCommand.BeginExecuteReader Metoda

Odwołanie

Definicja

Przestrzeń nazw:: Microsoft.Data.SqlClient

Zestaw:: Microsoft.Data.SqlClient.dll

Pakiet:: Microsoft.Data.SqlClient v1.0.19269.1

Pakiet:: Microsoft.Data.SqlClient v1.1.4

Pakiet:: Microsoft.Data.SqlClient v2.0.1

Pakiet:: Microsoft.Data.SqlClient v2.1.4

Pakiet:: Microsoft.Data.SqlClient v3.0.1

Pakiet:: Microsoft.Data.SqlClient v3.1.0

Pakiet:: Microsoft.Data.SqlClient v4.0.1

Pakiet:: Microsoft.Data.SqlClient v4.1.0

Pakiet:: Microsoft.Data.SqlClient v5.0.0

Pakiet:: Microsoft.Data.SqlClient v5.1.0

Pakiet:: Microsoft.Data.SqlClient v5.2.0

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Przeciążenia

BeginExecuteReader()	Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej, która jest opisana przez to SqlCommand i zwraca wyniki jako XmlReader obiekt.
BeginExecuteReader(CommandBehavior)	Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej za pomocą SqlCommand jednej z CommandBehavior wartości.
BeginExecuteReader(AsyncCallback, Object)	Inicjuje asynchroniczne wykonywanie instrukcji Języka Transact-SQL lub procedury składowanej opisanej przez to SqlCommand i zwraca wyniki jako XmlReader obiekt przy użyciu procedury wywołania zwrotnego.
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)	Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym SqlCommand elemecie , przy użyciu jednej z metod`CommandBehavior` wartości i pobieranie 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, która jest opisana przez to SqlCommand i zwraca wyniki jako XmlReader obiekt.

public:
 IAsyncResult ^ BeginExecuteReader();

public IAsyncResult BeginExecuteReader ();

member this.BeginExecuteReader : unit -> IAsyncResult

Public Function BeginExecuteReader () As IAsyncResult

Zwraca

IAsyncResult

Element IAsyncResult , który może służyć do sondowania lub oczekiwania na wyniki albo obu tych elementów. Ta wartość jest również potrzebna podczas wywoływaniaEndExecuteXmlReader , która zwraca pojedynczą wartość XML.

Wyjątki

InvalidCastException

Użyto SqlDbType wartości innej 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 wartości innej niż Char, NChar, NVarChar, VarChar lub Xml , gdy Value ustawiono wartość TextReader .

-lub-

Element SqlDbType inny niż Xml był używany, gdy Value został ustawiony na XmlReader wartość .

SqlException

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

-lub-

Podczas operacji przesyłania strumieniowego wystąpiło przekroczenie limitu czasu. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

InvalidOperationException

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.

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

IOException

Wystąpił błąd w Stream XmlReader 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.

ObjectDisposedException

XmlReader Obiekt Stream lub 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

Następująca aplikacja konsolowa uruchamia proces asynchronicznego pobierania danych XML. Podczas oczekiwania na wyniki ta prosta aplikacja znajduje się w pętli, badając IsCompleted wartość właściwości. Po zakończeniu procesu kod pobiera kod XML i wyświetla jego zawartość.

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

Uwagi

Metoda BeginExecuteXmlReader rozpoczyna proces asynchronicznego wykonywania instrukcji Języka Transact-SQL, która zwraca wiersze jako XML, aby inne zadania mogły być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteXmlReader , aby zakończyć operację i pobrać kod XML zwrócony przez polecenie . BeginExecuteXmlReader Metoda zwraca natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteXmlReader wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają synchroniczne lub asynchroniczne wykonywanie względem tego samego SqlCommand obiektu. EndExecuteXmlReader Wywołanie metody przed ukończeniem wykonywania polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.

Właściwość CommandText zwykle określa instrukcję Języka Transact-SQL z prawidłową klauzulą FOR XML. CommandText Można jednak również określić instrukcję, która zwraca ntext dane zawierające prawidłowy kod XML.

Typowe BeginExecuteXmlReader zapytanie można sformatować tak, jak w poniższym przykładzie w języku C#:

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

Tej metody można również użyć do pobrania zestawu wyników z jednym wierszem z jedną kolumną. W takim przypadku, jeśli zostanie zwrócony więcej niż jeden wiersz, EndExecuteXmlReader metoda dołącza XmlReader wartość do wartości w pierwszym wierszu i odrzuca resztę zestawu wyników.

Funkcja wielu aktywnych zestawów wyników (MARS) umożliwia korzystanie z tego samego połączenia przez wiele akcji.

Należy pamiętać, że tekst polecenia i parametry są wysyłane synchronicznie do serwera. Jeśli wysyłane jest 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 operacje odczytu są asynchroniczne. Mimo że wykonywanie polecenia jest asynchroniczne, pobieranie wartości jest nadal synchroniczne.

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

Jeśli używasz ExecuteReader funkcji lub BeginExecuteReader do uzyskiwania dostępu do danych XML, SQL Server zwraca 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ść .

Dotyczy

BeginExecuteReader(CommandBehavior)

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej za pomocą SqlCommand jednej z CommandBehavior 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

IAsyncResult

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

Wyjątki

InvalidCastException

-lub-

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

-lub-

Element SqlDbType inny niż Xml był używany, gdy Value został ustawiony na XmlReader wartość .

SqlException

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

-lub-

InvalidOperationException

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

IOException

ObjectDisposedException

Przykłady

Następująca aplikacja konsolowa uruchamia proces asynchronicznego pobierania czytnika danych. Podczas oczekiwania 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 wynikiem SqlDataReader , oraz optymalizację pod kątem pojedynczego wiersza.

// <Snippet1>
using System;
using System.Data;
using Microsoft.Data.SqlClient;
class Class1
{
    static void Main()
    {
        // This example is not terribly useful, but it proves a point.
        // The WAITFOR statement simply adds enough time to prove the 
        // asynchronous nature of the command.
        string commandText = "WAITFOR DELAY '00:00:03';" +
            "SELECT ProductID, Name FROM Production.Product WHERE ListPrice < 100";

        RunCommandAsynchronously(commandText, GetConnectionString());

        Console.WriteLine("Press ENTER to continue.");
        Console.ReadLine();
    }

    private static void RunCommandAsynchronously(
        string commandText, string connectionString)
    {
        // Given command text and connection string, asynchronously execute
        // the specified command against the connection. For this example,
        // the code displays an indicator as it is working, verifying the 
        // asynchronous behavior. 

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

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

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

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

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

    private static string GetConnectionString()
    {
        // To avoid storing the connection string in your code,            
        // you can retrieve it from a configuration file. 

        return "Data Source=(local);Integrated Security=true;" +
            "Initial Catalog=AdventureWorks";
    }
}
// </Snippet1>

Uwagi

Metoda BeginExecuteReader rozpoczyna proces asynchronicznego wykonywania instrukcji Języka Transact-SQL lub procedury składowanej, która zwraca 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ć SqlDataReader zwrócone przez polecenie . BeginExecuteReader Metoda zwraca natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteReader wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają synchroniczne lub asynchroniczne wykonywanie względem tego samego SqlCommand obiektu. EndExecuteReader Wywołanie metody przed ukończeniem wykonywania 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 tej wartości, aby upewnić się, że połączenie jest zamykane przez środowisko uruchomieniowe po SqlDataReader zamknięciu.

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

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

Dotyczy

BeginExecuteReader(AsyncCallback, Object)

Inicjuje asynchroniczne wykonywanie instrukcji Języka Transact-SQL lub procedury składowanej opisanej przez to SqlCommand i zwraca wyniki jako XmlReader obiekt przy użyciu procedury wywołania zwrotnego.

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. Zdanenull ( Nothing w programie Microsoft Visual Basic), aby wskazać, że nie jest wymagane żadne wywołanie zwrotne.

stateObject: Object

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

Zwraca

IAsyncResult

Element IAsyncResult , który może służyć do sondowania, oczekiwania na wyniki lub obu. Ta wartość jest również potrzebna, gdy EndExecuteXmlReader(IAsyncResult) jest wywoływana wartość , która zwraca wyniki polecenia jako XML.

Wyjątki

InvalidCastException

-lub-

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

-lub-

Element SqlDbType inny niż Xml był używany, gdy Value został ustawiony na XmlReader wartość .

SqlException

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

-lub-

InvalidOperationException

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

IOException

ObjectDisposedException

Przykłady

Poniższa aplikacja systemu Windows demonstruje użycie BeginExecuteXmlReader metody , wykonując instrukcję Języka Transact-SQL, która zawiera opóźnienie kilku sekund (emulując długotrwałe polecenie). W tym przykładzie obiekt wykonujący SqlCommand jest przekazywana jako stateObject parametr — dzięki temu można łatwo pobrać SqlCommand obiekt z procedury wywołania zwrotnego, dzięki czemu kod może wywołać EndExecuteXmlReader metodę odpowiadającą początkowemu wywołaniu metody BeginExecuteXmlReader.

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, w jaki sposób należy zablokować użytkownikom wielokrotne wykonywanie polecenia jednocześnie i upewnić się, że formularz nie zamyka się przed wywołaniem procedury wywołania zwrotnego.

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

// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Data.SqlClient;
using System.Xml;

namespace Microsoft.AdoDotNet.CodeSamples
{
    public partial class Form1 : Form
    {
        // Hook up the form's Load event handler and then add 
        // this code to the form's class:
        // You need these delegates in order to display text from a thread
        // other than the form's thread. See the HandleCallback
        // procedure for more information.
        private delegate void DisplayInfoDelegate(string Text);
        private delegate void DisplayReaderDelegate(XmlReader reader);

        private bool isExecuting;

        // This example maintains the connection object 
        // externally, so that it is available for closing.
        private SqlConnection connection;

        public Form1()
        {
            InitializeComponent();
        }

        private string GetConnectionString()
        {
            // To avoid storing the connection string in your code, 
            // you can retrieve it from a configuration file. 

            return "Data Source=(local);Integrated Security=true;" +
            "Initial Catalog=AdventureWorks";
        }

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

        private void ClearProductInfo()
        {
            // Clear the list box.
            this.listBox1.Items.Clear();
        }

        private void DisplayProductInfo(XmlReader reader)
        {
            // Display the data within the reader.
            while (reader.Read())
            {
                // Skip past items that are not from the correct table.
                if (reader.LocalName.ToString() == "Production.Product")
                {
                    this.listBox1.Items.Add(String.Format("{0}: {1:C}",
                        reader["Name"], Convert.ToDecimal(reader["ListPrice"])));
                }
            }
            DisplayStatus("Ready");
        }

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

        private void button1_Click(object sender, System.EventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this,
                    "Already executing. Please wait until the current query " +
                    "has completed.");
            }
            else
            {
                SqlCommand command = null;
                try
                {
                    ClearProductInfo();
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());

                    // To emulate a long-running query, wait for 
                    // a few seconds before working with the data.
                    string commandText =
                        "WAITFOR DELAY '00:00:03';" +
                        "SELECT Name, ListPrice FROM Production.Product " +
                        "WHERE ListPrice < 100 " +
                        "FOR XML AUTO, XMLDATA";

                    command = new SqlCommand(commandText, connection);
                    connection.Open();

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the 
                    // SqlCommand object as the second parameter in the 
                    // BeginExecuteXmlReader call, doing so makes it easier
                    // to call EndExecuteXmlReader in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteXmlReader(callback, command);

                }
                catch (Exception ex)
                {
                    isExecuting = false;
                    DisplayStatus(string.Format("Ready (last error: {0})", ex.Message));
                    if (connection != null)
                    {
                        connection.Close();
                    }
                }
            }
        }

        private void HandleCallback(IAsyncResult result)
        {
            try
            {
                // Retrieve the original command object, passed
                // to this procedure in the AsyncState property
                // of the IAsyncResult parameter.
                SqlCommand command = (SqlCommand)result.AsyncState;
                XmlReader reader = command.EndExecuteXmlReader(result);

                // You may not interact with the form and its contents
                // from a different thread, and this callback procedure
                // is all but guaranteed to be running from a different thread
                // than the form. 

                // Instead, you must call the procedure from the form's thread.
                // One simple way to accomplish this is to call the Invoke
                // method of the form, which calls the delegate you supply
                // from the form's thread. 
                DisplayReaderDelegate del = new DisplayReaderDelegate(DisplayProductInfo);
                this.Invoke(del, reader);

            }
            catch (Exception ex)
            {
                // Because you are now running code in a separate thread, 
                // if you do not handle the exception here, none of your other
                // code catches the exception. Because none of 
                // your code is on the call stack in this thread, there is nothing
                // higher up the stack to catch the exception if you do not 
                // handle it here. You can either log the exception or 
                // invoke a delegate (as in the non-error case in this 
                // example) to display the error on the form. In no case
                // can you simply display the error without executing a delegate
                // as in the try block here. 

                // You can create the delegate instance as you 
                // invoke it, like this:
                this.Invoke(new DisplayInfoDelegate(DisplayStatus),
                String.Format("Ready(last error: {0}", ex.Message));
            }
            finally
            {
                isExecuting = false;
                if (connection != null)
                {
                    connection.Close();
                }
            }
        }

        private void Form1_Load(object sender, System.EventArgs e)
        {
            this.button1.Click += new System.EventHandler(this.button1_Click);
            this.FormClosing += new System.Windows.Forms.
                FormClosingEventHandler(this.Form1_FormClosing);
        }
    }
}
// </Snippet1>

Uwagi

Metoda BeginExecuteXmlReader rozpoczyna proces asynchronicznego wykonywania instrukcji Języka Transact-SQL lub procedury składowanej, która zwraca wiersze jako XML, aby inne zadania mogły być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteXmlReader , aby zakończyć operację i pobrać żądane dane XML. BeginExecuteXmlReader Metoda zwraca natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteXmlReader wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają synchroniczne lub asynchroniczne wykonywanie względem tego samego SqlCommand obiektu. EndExecuteXmlReader Wywołanie metody przed ukończeniem wykonywania polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.

Właściwość CommandText zwykle określa instrukcję Języka Transact-SQL z prawidłową klauzulą FOR XML. CommandText Można jednak również określić instrukcję, która zwraca dane zawierające prawidłowy kod XML. Tej metody można również użyć do pobrania zestawu wyników z jednym wierszem z jedną kolumną. W takim przypadku, jeśli zostanie zwrócony więcej niż jeden wiersz, EndExecuteXmlReader metoda dołącza XmlReader wartość do wartości w pierwszym wierszu i odrzuca resztę zestawu wyników.

Typowe BeginExecuteXmlReader zapytanie można sformatować tak, jak w poniższym przykładzie w języku C#:

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

Tej metody można również użyć do pobrania zestawu wyników z jednym wierszem z jedną kolumną. W takim przypadku, jeśli zostanie zwrócony więcej niż jeden wiersz, EndExecuteXmlReader metoda dołącza XmlReader wartość do wartości w pierwszym wierszu i odrzuca resztę zestawu wyników.

Funkcja wielu aktywnych zestawów wyników (MARS) umożliwia korzystanie z tego samego połączenia przez wiele akcji.

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

Należy pamiętać, że tekst polecenia i parametry są wysyłane synchronicznie do serwera. 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 operacje odczytu są asynchroniczne.

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

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym SqlCommand elemecie , przy użyciu jednej z instrukcjiCommandBehavior wartości i pobieranie co najmniej 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. Zdanenull ( Nothing w programie Microsoft Visual Basic), aby wskazać, że nie jest wymagane żadne wywołanie zwrotne.

stateObject: Object

Obiekt stanu zdefiniowany przez użytkownika, który jest 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

IAsyncResult

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 zwróconych wierszy.

Wyjątki

InvalidCastException

-lub-

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

-lub-

Element SqlDbType inny niż Xml był używany, gdy Value został ustawiony na XmlReader wartość .

SqlException

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

-lub-

InvalidOperationException

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

IOException

ObjectDisposedException

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ć EndExecuteReader metodę odpowiadającą początkowemu wywołaniu metody BeginExecuteReader.

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

W tym przykładzie przekazywana CommandBehavior.CloseConnection jest wartość w parametrze behavior , co powoduje SqlDataReader automatyczne zamknięcie połączenia po zamknięciu.

// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Data.SqlClient;

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

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

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

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

        private void FillGrid(SqlDataReader reader)
        {
            try
            {
                DataTable table = new DataTable();
                table.Load(reader);
                this.dataGridView1.DataSource = table;
                DisplayStatus("Ready");
            }
            catch (Exception ex)
            {
                // Because you are guaranteed this procedure
                // is running from within the form's thread,
                // it can directly interact with members of the form.
                DisplayStatus(string.Format("Ready (last attempt failed: {0})",
                    ex.Message));
            }
            finally
            {
                // Closing the reader also closes the connection,
                // because this reader was created using the 
                // CommandBehavior.CloseConnection value.
                if (reader != null)
                {
                    reader.Close();
                }
            }
        }

        private void HandleCallback(IAsyncResult result)
        {
            try
            {
                // Retrieve the original command object, passed
                // to this procedure in the AsyncState property
                // of the IAsyncResult parameter.
                SqlCommand command = (SqlCommand)result.AsyncState;
                SqlDataReader reader = command.EndExecuteReader(result);
                // You may not interact with the form and its contents
                // from a different thread, and this callback procedure
                // is all but guaranteed to be running from a different thread
                // than the form. Therefore you cannot simply call code that 
                // fills the grid, like this:
                // FillGrid(reader);
                // Instead, you must call the procedure from the form's thread.
                // One simple way to accomplish this is to call the Invoke
                // method of the form, which calls the delegate you supply
                // from the form's thread. 
                FillGridDelegate del = new FillGridDelegate(FillGrid);
                this.Invoke(del, reader);
                // Do not close the reader here, because it is being used in 
                // a separate thread. Instead, have the procedure you have
                // called close the reader once it is done with it.
            }
            catch (Exception ex)
            {
                // Because you are now running code in a separate thread, 
                // if you do not handle the exception here, none of your other
                // code catches the exception. Because there is none of 
                // your code on the call stack in this thread, there is nothing
                // higher up the stack to catch the exception if you do not 
                // handle it here. You can either log the exception or 
                // invoke a delegate (as in the non-error case in this 
                // example) to display the error on the form. In no case
                // can you simply display the error without executing a delegate
                // as in the try block here. 
                // You can create the delegate instance as you 
                // invoke it, like this:
                this.Invoke(new DisplayStatusDelegate(DisplayStatus), "Error: " +
                    ex.Message);
            }
            finally
            {
                isExecuting = false;
            }
        }

        private string GetConnectionString()
        {
            // To avoid storing the connection string in your code, 
            // you can retrieve it from a configuration file. 

            return "Data Source=(local);Integrated Security=true;" +
                "Initial Catalog=AdventureWorks";
        }

        private void button1_Click(object sender, System.EventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this,
                    "Already executing. Please wait until the current query " +
                    "has completed.");
            }
            else
            {
                SqlCommand command = null;
                SqlConnection connection = null;
                try
                {
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());
                    // To emulate a long-running query, wait for 
                    // a few seconds before retrieving the real data.
                    command = new SqlCommand("WAITFOR DELAY '0:0:5';" +
                        "SELECT ProductID, Name, ListPrice, Weight FROM Production.Product",
                        connection);
                    connection.Open();

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the 
                    // SqlCommand object as the second parameter in the 
                    // BeginExecuteReader call, doing so makes it easier
                    // to call EndExecuteReader in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteReader(callback, command,
                        CommandBehavior.CloseConnection);
                }
                catch (Exception ex)
                {
                    DisplayStatus("Error: " + ex.Message);
                    if (connection != null)
                    {
                        connection.Close();
                    }
                }
            }
        }

        private void Form1_Load(object sender, System.EventArgs e)
        {
            this.button1.Click += new System.EventHandler(this.button1_Click);
            this.FormClosing += new FormClosingEventHandler(Form1_FormClosing);
        }

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

Uwagi

Parametr callback umożliwia określenie delegata AsyncCallback , który jest wywoływany po zakończeniu instrukcji. Metodę EndExecuteReader można wywołać z poziomu tej procedury delegata lub z dowolnej innej lokalizacji w aplikacji. Ponadto można przekazać dowolny obiekt w parametrze stateObject , a procedura wywołania zwrotnego AsyncState może pobrać te informacje przy użyciu 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 tej wartości, aby upewnić się, że połączenie jest zamykane przez środowisko uruchomieniowe po SqlDataReader zamknięciu. Deweloperzy mogą również zoptymalizować zachowanie SqlDataReader obiektu, określając SingleRow wartość, gdy wiadomo z wyprzedzeniem, że instrukcja Transact-SQL lub procedura składowana zwraca tylko jeden wiersz.

Ponieważ procedura wywołania zwrotnego jest wykonywana z poziomu wątku w tle dostarczonego przez środowisko uruchomieniowe języka wspólnego 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.

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

Dotyczy

Udostępnij za pośrednictwem

SqlCommand.BeginExecuteReader Metoda

Definicja

Przeciążenia

BeginExecuteReader()

Zwraca

Wyjątki

Przykłady

Uwagi

Dotyczy

BeginExecuteReader(CommandBehavior)

Parametry

Zwraca

Wyjątki

Przykłady

Uwagi

Dotyczy

BeginExecuteReader(AsyncCallback, Object)

Parametry

Zwraca

Wyjątki

Przykłady

Uwagi

Zobacz też

Dotyczy

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Parametry

Zwraca

Wyjątki

Przykłady

Uwagi

Dotyczy

Dodatkowe zasoby