SqlCommand.BeginExecuteReader Metoda

Definice

Obor názvů:

Microsoft.Data.SqlClient

Sestavení:

Microsoft.Data.SqlClient.dll

Balíček:

Microsoft.Data.SqlClient v7.0.1

Přetížení

Name	Description
BeginExecuteReader()	Zahájí asynchronní spuštění příkazu Transact-SQL nebo uložené procedury popsané tímto SqlCommandpříkazem a načte jednu nebo více sad výsledků ze serveru.
BeginExecuteReader(CommandBehavior)	Inicializuje asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána pomocí SqlCommand jedné z CommandBehavior hodnot.
BeginExecuteReader(AsyncCallback, Object)	Zahájí asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommand způsobem, a vrátí výsledky jako XmlReader objekt pomocí procedury zpětného volání.
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)	Inicializuje asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommand , pomocí jednoho z CommandBehavior hodnoty a načtení jedné nebo více sad výsledků ze serveru zadanou procedurou zpětného volání a informacemi o stavu.

BeginExecuteReader()

Zahájí asynchronní spuštění příkazu Transact-SQL nebo uložené procedury popsané tímto SqlCommandpříkazem a načte jednu nebo více sad výsledků ze serveru.

public:
 IAsyncResult ^ BeginExecuteReader();

public IAsyncResult BeginExecuteReader();

member this.BeginExecuteReader : unit -> IAsyncResult

Public Function BeginExecuteReader () As IAsyncResult

Návraty

IAsyncResult

To IAsyncResult lze použít k dotazování nebo čekání na výsledky, nebo obojí; tato hodnota je také nutná při vyvolání EndExecuteReader(IAsyncResult), která vrátí SqlDataReader instanci, která se dá použít k načtení vrácených řádků.

Výjimky

InvalidCastException

• Jiný SqlDbType než Binary nebo VarBinary byl použit při Value nastavení Stream. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
• Jiný SqlDbType než Char, , NChar, NVarCharVarCharnebo Xml byl použit při Value nastavení TextReader.
• Jiné SqlDbType , než Xml bylo použito při Value nastavení XmlReader.

SqlException

• Jakákoli chyba, ke které došlo při provádění textu příkazu.
• Během operace streamování došlo k vypršení časového limitu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

InvalidOperationException

• Zavřený SqlConnection nebo ukončený během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
• EnableOptimizedParameterBinding je nastavena na hodnotu true a parametr se směrem Output nebo InputOutput byl přidán do Parameters kolekce.

IOException

Během operace streamování došlo k chybě nebo StreamXmlReaderTextReader objektu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

ObjectDisposedException

Stream Objekt XmlReadernebo TextReader objekt byl uzavřen během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

Příklady

Následující konzolová aplikace spustí proces asynchronního načítání čtečky dat. Při čekání na výsledky se tato jednoduchá aplikace nachází ve smyčce a zkoumá IsCompleted hodnotu vlastnosti. Jakmile se proces dokončí, kód načte SqlDataReader a zobrazí jeho obsah.

using System;
using Microsoft.Data.SqlClient;

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

        RunCommandAsynchronously(commandText, GetConnectionString());

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

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

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

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

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

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

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

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

Poznámky

Metoda BeginExecuteReader() spustí proces asynchronního spuštění příkazu Transact-SQL nebo uložené procedury, která vrací řádky, aby ostatní úlohy mohly běžet souběžně při provádění příkazu. Po dokončení příkazu musí vývojáři volat metodu EndExecuteReader(IAsyncResult) , aby dokončili operaci a načetli vrácenou SqlDataReader příkazem. Metoda BeginExecuteReader() vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteReader(IAsyncResult) volání metody, nesmí provádět žádné další volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteReader(IAsyncResult) Voláním před dokončením SqlCommand příkazu se objekt zablokuje, dokud se provádění nedokončí.

Všimněte si, že text příkazu a parametry se odesílají synchronně na server. Pokud se odešle velký příkaz nebo mnoho parametrů, může tato metoda blokovat během zápisu. Po odeslání příkazu vrátí metoda okamžitě bez čekání na odpověď ze serveru – to znamená, že čtení jsou asynchronní. I když je provádění příkazů asynchronní, načítání hodnot je stále synchronní. To znamená, že volání, která Read() se mají blokovat, pokud je vyžadováno více dat, a bloky operací čtení základní sítě.

Vzhledem k tomu, že toto přetížení nepodporuje proceduru zpětného volání, musí vývojáři buď dotazovat, zda byl příkaz dokončen, pomocí IsCompleted vlastnosti IAsyncResult vrácené metodou BeginExecuteReader() ; nebo počkat na dokončení jednoho nebo více příkazů pomocí AsyncWaitHandle vlastnosti vrácené IAsyncResult.

Pokud používáte ExecuteReader() nebo BeginExecuteReader() přistupujete k datům XML, VRÁTÍ SQL Server všechny výsledky XML větší než 2 033 znaků v několika řádcích o 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader() nebo BeginExecuteXmlReader() načtěte dotazy FOR XML.

Tato metoda ignoruje CommandTimeout vlastnost.

BeginExecuteReader(CommandBehavior)

Inicializuje asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána pomocí SqlCommand jedné z CommandBehavior hodnot.

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

Jedna z CommandBehavior hodnot označujících možnosti pro spuštění příkazu a načtení dat.

Návraty

IAsyncResult

Tuto IAsyncResult hodnotu je možné použít k dotazování, čekání na výsledky nebo obojí; tato hodnota je také nutná při vyvolání EndExecuteReader(IAsyncResult), která vrátí SqlDataReader instanci, která se dá použít k načtení vrácených řádků.

Výjimky

InvalidCastException

• Jiný SqlDbType než Binary nebo VarBinary byl použit při Value nastavení Stream. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
• Jiný SqlDbType než Char, , NChar, NVarCharVarCharnebo Xml byl použit při Value nastavení TextReader.
• Jiné SqlDbType , než Xml bylo použito při Value nastavení XmlReader.

SqlException

• Jakákoli chyba, ke které došlo při provádění textu příkazu.
• Během operace streamování došlo k vypršení časového limitu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

InvalidOperationException

• Zavřený SqlConnection nebo ukončený během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
• EnableOptimizedParameterBinding je nastavena na hodnotu true a parametr se směrem Output nebo InputOutput byl přidán do Parameters kolekce.

IOException

Během operace streamování došlo k chybě nebo StreamXmlReaderTextReader objektu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

ObjectDisposedException

Stream Objekt XmlReadernebo TextReader objekt byl uzavřen během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

Příklady

Následující konzolová aplikace spustí proces asynchronního načítání čtečky dat. Při čekání na výsledky se tato jednoduchá aplikace nachází ve smyčce a zkoumá IsCompleted hodnotu vlastnosti. Po dokončení procesu kód načte SqlDataReader a zobrazí jeho obsah.

Tento příklad také předá CloseConnection hodnoty a SingleRow hodnoty v parametru chování, což způsobí zavření připojení s vráceným kódem SqlDataReader a optimalizaci pro výsledek jednoho řádku.

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

Poznámky

Metoda BeginExecuteReader() spustí proces asynchronního spuštění příkazu Transact-SQL nebo uložené procedury, která vrací řádky, aby ostatní úlohy mohly běžet souběžně při provádění příkazu. Po dokončení příkazu musí vývojáři volat metodu EndExecuteReader(IAsyncResult) , aby dokončili operaci a načetli vrácenou SqlDataReader příkazem. Metoda BeginExecuteReader() vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteReader(IAsyncResult) volání metody, nesmí provádět žádné další volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteReader(IAsyncResult) Voláním před dokončením SqlCommand příkazu se objekt zablokuje, dokud se provádění nedokončí.

Parametr behavior umožňuje zadat možnosti, které řídí chování příkazu a jeho připojení. Tyto hodnoty je možné zkombinovat (pomocí operátoru programovacího OR jazyka), obecně platí, že vývojáři používají CommandBehavior.CloseConnection tuto hodnotu, aby se zajistilo, že je připojení při zavření zavřené modulem runtime SqlDataReader .

Všimněte si, že text příkazu a parametry se odesílají synchronně na server. Pokud se odešle velký příkaz nebo mnoho parametrů, může tato metoda blokovat během zápisu. Po odeslání příkazu vrátí metoda okamžitě bez čekání na odpověď ze serveru – to znamená, že čtení jsou asynchronní. I když je provádění příkazů asynchronní, načítání hodnot je stále synchronní. To znamená, že volání, která Read() se mají blokovat, pokud je vyžadováno více dat, a bloky operací čtení základní sítě.

Vzhledem k tomu, že toto přetížení nepodporuje proceduru zpětného volání, musí vývojáři buď dotazovat, zda byl příkaz dokončen, pomocí IsCompleted vlastnosti IAsyncResult vrácené metodou BeginExecuteNonQuery() ; nebo počkat na dokončení jednoho nebo více příkazů pomocí AsyncWaitHandle vlastnosti vrácené IAsyncResult.

Pokud používáte ExecuteReader() nebo BeginExecuteReader() přistupujete k datům XML, vrátí SQL Server všechny výsledky XML delší než 2 033 znaků v několika řádcích o 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader() nebo BeginExecuteXmlReader() načtěte dotazy FOR XML.

Tato metoda ignoruje CommandTimeout vlastnost.

BeginExecuteReader(AsyncCallback, Object)

Zahájí asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommand způsobem, a vrátí výsledky jako XmlReader objekt pomocí procedury zpětného volání.

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

AsyncCallback Delegát, který je vyvolán po dokončení provádění příkazu. Předat null ( Nothing v Microsoft Visual Basic) označující, že se nevyžaduje zpětné volání.

stateObject

Object

Objekt stavu definovaný uživatelem, který se předává do procedury zpětného volání. Načtěte tento objekt z procedury zpětného volání pomocí AsyncState vlastnosti.

Návraty

IAsyncResult

Tuto IAsyncResult hodnotu je možné použít k dotazování, čekání na výsledky nebo obojí. Tato hodnota se také vyžaduje při EndExecuteXmlReader(IAsyncResult) zavolání, která vrátí výsledky příkazu jako XML.

Výjimky

InvalidCastException

SqlDbType Jiný než Binary nebo VarBinary byl použit při Value nastavení Stream . Další informace o streamování najdete v tématu Podpora streamování SqlClient.

- nebo -

SqlDbType Jiná hodnota než Char, NChar, NVarChar, VarChar nebo Xml byla použita při Value nastavení TextReader .

- nebo -

SqlDbType Jiná než Xml byla použita při Value nastavení na XmlReader hodnotu .

SqlException

Jakákoli chyba, ke které došlo při provádění textu příkazu.

- nebo -

Během operace streamování došlo k vypršení časového limitu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

InvalidOperationException

Zavřený SqlConnection nebo ukončený během operace streamování. Další informace o streamování najdete v tématu Podpora streamování 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

Během operace streamování došlo k chybě nebo StreamXmlReaderTextReader objektu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

ObjectDisposedException

XmlReader Objekt Stream nebo TextReader objekt byl uzavřen během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

Příklady

Následující aplikace systému Windows ukazuje použití BeginExecuteXmlReader metody, spuštění příkazu Transact-SQL, který zahrnuje zpoždění několika sekund (emulace dlouhotrvajícího příkazu). Tento příklad předá exekuční SqlCommand objekt jako stateObject parametr- tím usnadňuje načtení SqlCommand objektu z procedury zpětného volání, aby kód mohl volat metodu EndExecuteXmlReader odpovídající počátečnímu volání BeginExecuteXmlReader.

Tento příklad ukazuje mnoho důležitých technik. To zahrnuje volání metody, která komunikuje s formulářem z samostatného vlákna. Kromě toho tento příklad ukazuje, jak je nutné uživatelům zablokovat provádění příkazu vícekrát souběžně a jak musíte zajistit, aby se formulář nezavřel před voláním procedury zpětného volání.

Pokud chcete tento příklad nastavit, vytvořte novou aplikaci pro Windows. Button Umístěte ovládací prvek, ListBox ovládací prvek a Label ovládací prvek do formuláře (přijměte výchozí název každého ovládacího prvku). Do třídy formuláře přidejte následující kód a podle potřeby upravte připojovací řetězec pro vaše prostředí.

/* This does not compile, as multiple methods are missing.
// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Data.SqlClient;
using System.Xml;

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

        private bool isExecuting;

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

        public Form1()
        {
            InitializeComponent();
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Poznámky

Metoda BeginExecuteXmlReader spustí proces asynchronního spuštění příkazu Transact-SQL nebo uložené procedury, která vrací řádky jako XML, aby ostatní úlohy mohly běžet souběžně při provádění příkazu. Po dokončení příkazu musí vývojáři volat metodu EndExecuteXmlReader , aby dokončili operaci a načetli požadovaná data XML. Metoda BeginExecuteXmlReader vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteXmlReader volání metody, nesmí provádět žádné další volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteXmlReader Voláním před dokončením SqlCommand příkazu se objekt zablokuje, dokud se provádění nedokončí.

Vlastnost CommandText obvykle určuje příkaz Transact-SQL s platnou klauzulí FOR XML. CommandText Můžete však také zadat příkaz, který vrací data obsahující platné XML. Tuto metodu lze také použít k načtení sady výsledků s jedním řádkem a jedním sloupcem. V tomto případě, pokud je vrácen více než jeden řádek, EndExecuteXmlReader metoda připojí XmlReader k hodnotě na prvním řádku a zahodí zbytek sady výsledků.

Typický BeginExecuteXmlReader dotaz je možné naformátovat jako v následujícím příkladu jazyka C#:

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

Tuto metodu lze také použít k načtení sady výsledků s jedním řádkem a jedním sloupcem. V tomto případě, pokud je vrácen více než jeden řádek, EndExecuteXmlReader metoda připojí XmlReader k hodnotě na prvním řádku a zahodí zbytek sady výsledků.

Funkce více aktivních sad výsledků (MARS) umožňuje více akcím používat stejné připojení.

Parametr callback umožňuje zadat delegáta AsyncCallback , který je volána po dokončení příkazu. Metodu EndExecuteXmlReader můžete volat z tohoto postupu delegáta nebo z libovolného jiného umístění v aplikaci. Kromě toho můžete předat libovolný objekt v parametru stateObject a procedura zpětného AsyncState volání může načíst tyto informace pomocí vlastnosti.

Všimněte si, že text příkazu a parametry se odesílají synchronně na server. Pokud je odeslán velký příkaz nebo mnoho parametrů, tato metoda může blokovat během zápisu. Po odeslání příkazu metoda vrátí okamžitě bez čekání na odpověď ze serveru - to znamená, čtení jsou asynchronní.

Všechny chyby, ke kterým dochází během provádění operace, jsou vyvolány jako výjimky v postupu zpětného volání. Výjimku musíte zpracovat v postupu zpětného volání, nikoli v hlavní aplikaci. Další informace o zpracování výjimek v postupu zpětného volání najdete v příkladu v tomto tématu.

Pokud používáte ExecuteReader nebo BeginExecuteReader přistupujete k datům XML, VRÁTÍ SQL Server všechny výsledky XML větší než 2 033 znaků v několika řádcích o 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader nebo BeginExecuteXmlReader načtěte dotazy FOR XML.

Tato metoda ignoruje CommandTimeout vlastnost.

Viz také

• EndExecuteXmlReader(IAsyncResult)
• ExecuteXmlReader()

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Inicializuje asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommand , pomocí jednoho z CommandBehavior hodnoty a načtení jedné nebo více sad výsledků ze serveru zadanou procedurou zpětného volání a informacemi o stavu.

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

AsyncCallback Delegát, který je vyvolán po dokončení provádění příkazu. Předat null ( Nothing v Microsoft Visual Basic) označující, že se nevyžaduje zpětné volání.

stateObject

Object

Objekt stavu definovaný uživatelem, který se předává do procedury zpětného volání. Načtěte tento objekt z procedury zpětného volání pomocí AsyncState vlastnosti.

behavior

CommandBehavior

Jedna z CommandBehavior hodnot označujících možnosti pro spuštění příkazu a načtení dat.

Návraty

IAsyncResult

To IAsyncResult lze použít k dotazování nebo čekání na výsledky, nebo obojí; tato hodnota je také nutná při vyvolání EndExecuteReader(IAsyncResult) , která vrátí SqlDataReader instanci, která se dá použít k načtení vrácených řádků.

Výjimky

InvalidCastException

SqlDbType Jiný než Binary nebo VarBinary byl použit při Value nastavení Stream . Další informace o streamování najdete v tématu Podpora streamování SqlClient.

- nebo -

SqlDbType Jiná hodnota než Char, NChar, NVarChar, VarChar nebo Xml byla použita při Value nastavení TextReader .

- nebo -

SqlDbType Jiná než Xml byla použita při Value nastavení na XmlReader hodnotu .

SqlException

Jakákoli chyba, ke které došlo při provádění textu příkazu.

- nebo -

Během operace streamování došlo k vypršení časového limitu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

InvalidOperationException

Zavřený SqlConnection nebo ukončený během operace streamování. Další informace o streamování najdete v tématu Podpora streamování 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

Během operace streamování došlo k chybě nebo StreamXmlReaderTextReader objektu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

ObjectDisposedException

XmlReader Objekt Stream nebo TextReader objekt byl uzavřen během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

Příklady

Následující aplikace systému Windows ukazuje použití BeginExecuteReader metody, spuštění příkazu Transact-SQL, který zahrnuje zpoždění několika sekund (emulace dlouhotrvajícího příkazu). Vzhledem k tomu, že ukázka spustí příkaz asynchronně, zůstane formulář při čekání na výsledky responzivní. Tento příklad předá spuštěný SqlCommand objekt jako stateObject parametr; tím usnadňuje načtení SqlCommand objektu z procedury zpětného volání, aby kód mohl volat metodu EndExecuteReader odpovídající počátečnímu volání BeginExecuteReader.

Tento příklad ukazuje mnoho důležitých technik. To zahrnuje volání metody, která komunikuje s formulářem z samostatného vlákna. Kromě toho tento příklad ukazuje, jak je nutné uživatelům zablokovat provádění příkazu vícekrát souběžně a jak musíte zajistit, aby se formulář nezavřel před voláním procedury zpětného volání.

Pokud chcete tento příklad nastavit, vytvořte novou aplikaci pro Windows. Button Umístěte ovládací prvek, DataGridView ovládací prvek a Label ovládací prvek do formuláře (přijměte výchozí název každého ovládacího prvku). Do třídy formuláře přidejte následující kód a podle potřeby upravte připojovací řetězec pro vaše prostředí.

Tento příklad předá CommandBehavior.CloseConnection hodnotu v parametru behavior , což způsobí, že vrácená SqlDataReader funkce automaticky zavře připojení při zavření.

#if NETFRAMEWORK
#nullable enable

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

namespace SqlCommand_BeginExecuteReaderAsyncBehavior
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
            this.label1 = new Label();
            this.dataGridView1 = new DataGridView();
            this.button1 = new Button();
        }

        private void InitializeComponent() { }

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

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

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

        private Label label1 { get; set; }

        private DataGridView dataGridView1 { get; set; }

        private Button button1 { get; set; }

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

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

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

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

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

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

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

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

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

Poznámky

Metoda BeginExecuteReader spustí proces asynchronního spuštění příkazu Transact-SQL nebo uložené procedury, která vrací řádky, aby ostatní úlohy mohly běžet souběžně při provádění příkazu. Po dokončení příkazu musí vývojáři volat metodu EndExecuteReader , aby dokončili operaci a načetli vrácenou SqlDataReader příkazem. Metoda BeginExecuteReader vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteReader volání metody, nesmí provádět žádné další volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteReader Voláním před dokončením SqlCommand příkazu se objekt zablokuje, dokud se provádění nedokončí.

Parametr callback umožňuje zadat delegáta AsyncCallback , který je volána po dokončení příkazu. Metodu EndExecuteReader můžete volat z tohoto postupu delegáta nebo z libovolného jiného umístění v aplikaci. Kromě toho můžete předat libovolný objekt v parametru stateObject a procedura zpětného AsyncState volání může načíst tyto informace pomocí vlastnosti.

Parametr behavior umožňuje zadat možnosti, které řídí chování příkazu a jeho připojení. Tyto hodnoty se dají zkombinovat dohromady (pomocí operátoru programovacího Or jazyka), obecně platí, že vývojáři používají CloseConnection tuto hodnotu, aby se zajistilo, že je připojení zavřené modulem runtime při zavření SqlDataReader . Vývojáři mohou také optimalizovat chování SqlDataReader zadáním SingleRow hodnoty, pokud je předem známo, že příkaz Transact-SQL nebo uložená procedura vrací pouze jeden řádek.

Všimněte si, že text příkazu a parametry se odesílají synchronně na server. Pokud se odešle velký příkaz nebo mnoho parametrů, může tato metoda blokovat během zápisu. Po odeslání příkazu metoda vrátí okamžitě bez čekání na odpověď ze serveru - to znamená, čtení jsou asynchronní. I když je provádění příkazů asynchronní, načítání hodnot je stále synchronní. To znamená, že volání, která Read se mají blokovat, pokud je vyžadováno více dat, a bloky operací čtení základní sítě.

Vzhledem k tomu, že se procedura zpětného volání provádí z vlákna na pozadí dodaného modulem Clr (Common Language Runtime) Microsoft .NET, je velmi důležité, abyste při zpracování interakcí mezi vlákny z vašich aplikací provedli důkladný přístup. Například nesmíte pracovat s obsahem formuláře v rámci procedury zpětného volání – pokud potřebujete formulář aktualizovat, musíte přepnout zpět na vlákno formuláře, aby bylo možné provést svou práci. Příklad v tomto tématu ukazuje toto chování.

Všechny chyby, ke kterým dochází během provádění operace, jsou vyvolány jako výjimky v postupu zpětného volání. Výjimku musíte zpracovat v postupu zpětného volání, nikoli v hlavní aplikaci. Další informace o zpracování výjimek v postupu zpětného volání najdete v příkladu v tomto tématu.

Pokud používáte ExecuteReader nebo BeginExecuteReader přistupujete k datům XML, VRÁTÍ SQL Server všechny výsledky XML větší než 2 033 znaků v několika řádcích o 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader nebo BeginExecuteXmlReader načtěte dotazy FOR XML.

Tato metoda ignoruje CommandTimeout vlastnost.