Compartilhar via


SqlCommand.BeginExecuteReader Método

Definição

Sobrecargas

BeginExecuteReader()

Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand e retorna resultados como um objeto XmlReader.

BeginExecuteReader(CommandBehavior)

Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand usando um dos valores CommandBehavior.

BeginExecuteReader(AsyncCallback, Object)

Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand e retorna resultados como um objeto XmlReader usando um procedimento de retorno de chamada.

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand , usando um dosCommandBehavior e recuperação de um ou mais conjuntos de resultados do servidor, considerando um procedimento de retorno de chamada e informações de estado.

BeginExecuteReader()

Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand e retorna resultados como um objeto XmlReader.

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

Retornos

Um IAsyncResult que pode ser usado para sondar ou aguardar resultados ou ambos; esse valor também é necessário ao invocarEndExecuteXmlReader , que retorna um único valor XML.

Exceções

Um SqlDbType diferente de Binary ou VarBinary foi usado quando Value foi definido como Stream . Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

- ou -

Um SqlDbType diferente de Char, NChar, NVarChar, VarChar ou Xml foi usado quando Value foi definido como TextReader .

-ou-

Um SqlDbType diferente de Xml foi usado quando Value foi definido como XmlReader .

Qualquer erro ocorrido ao executar o texto do comando.

- ou -

Ocorreu um tempo limite durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

O SqlConnection foi fechado ou removido durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do 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.

Ocorreu um erro em um Stream objeto ou TextReaderXmlReader durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

O Stream objeto ou TextReaderXmlReader foi fechado durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

Exemplos

O aplicativo de console a seguir inicia o processo de recuperação de dados XML de forma assíncrona. Enquanto aguarda os resultados, esse aplicativo simples fica em um loop, investigando o valor da IsCompleted propriedade. Depois que o processo for concluído, o código recuperará o XML e exibirá seu conteúdo.

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

Comentários

O BeginExecuteXmlReader método inicia o processo de execução assíncrona de uma instrução Transact-SQL que retorna linhas como XML, para que outras tarefas possam ser executadas simultaneamente enquanto a instrução está sendo executada. Quando a instrução for concluída, os desenvolvedores deverão chamar o EndExecuteXmlReader método para concluir a operação e recuperar o XML retornado pelo comando . O BeginExecuteXmlReader método retorna imediatamente, mas até que o código execute a chamada de método correspondente EndExecuteXmlReader , ele não deve executar nenhuma outra chamada que inicie uma execução síncrona ou assíncrona no mesmo SqlCommand objeto. Chamar o EndExecuteXmlReader antes que a execução do comando seja concluída faz com que o SqlCommand objeto seja bloqueado até que a execução seja concluída.

A CommandText propriedade normalmente especifica uma instrução Transact-SQL com uma cláusula FOR XML válida. No entanto, CommandText também pode especificar uma instrução que retorna ntext dados que contêm XML válido.

Uma consulta típica BeginExecuteXmlReader pode ser formatada como no exemplo de C# a seguir:

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

Esse método também pode ser usado para recuperar um conjunto de resultados de linha única e de coluna única. Nesse caso, se mais de uma linha for retornada, o EndExecuteXmlReader método anexa o XmlReader ao valor na primeira linha e descarta o restante do conjunto de resultados.

O recurso MARS (conjunto de resultados ativo múltiplo) permite que várias ações usem a mesma conexão.

Observe que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se um comando grande ou muitos parâmetros forem enviados, esse método poderá ser bloqueado durante as gravações. Depois que o comando é enviado, o método retorna imediatamente sem aguardar uma resposta do servidor , ou seja, as leituras são assíncronas. Embora a execução de comando seja assíncrona, a busca de valor ainda é síncrona.

Como essa sobrecarga não dá suporte a um procedimento de retorno de chamada, os desenvolvedores precisam sondar para determinar se o comando foi concluído, usando a IsCompleted propriedade do IAsyncResult retornado pelo BeginExecuteXmlReader método ou aguardar a conclusão de um ou mais comandos usando a AsyncWaitHandle propriedade do retornado IAsyncResult.

Se você usar ExecuteReader ou BeginExecuteReader acessar dados XML, SQL Server retornará qualquer resultado XML maior que 2.033 caracteres de comprimento em várias linhas de 2.033 caracteres cada. Para evitar esse comportamento, use ExecuteXmlReader ou BeginExecuteXmlReader leia consultas FOR XML.

Esse método ignora a CommandTimeout propriedade .

Aplica-se a

BeginExecuteReader(CommandBehavior)

Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand usando um dos valores CommandBehavior.

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

Parâmetros

behavior
CommandBehavior

Um dos valores CommandBehavior que indica opções de execução de instrução e recuperação de dados.

Retornos

Um IAsyncResult que pode ser usado para sondar, aguardar resultados ou ambos; esse valor também é necessário ao invocar EndExecuteReader(IAsyncResult) , que retorna uma SqlDataReader instância que pode ser usada para recuperar as linhas retornadas.

Exceções

Um SqlDbType diferente de Binary ou VarBinary foi usado quando Value foi definido como Stream . Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

- ou -

Um SqlDbType diferente de Char, NChar, NVarChar, VarChar ou Xml foi usado quando Value foi definido como TextReader .

-ou-

Um SqlDbType diferente de Xml foi usado quando Value foi definido como XmlReader .

Qualquer erro ocorrido ao executar o texto do comando.

- ou -

Ocorreu um tempo limite durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

O SqlConnection foi fechado ou removido durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do 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.

Ocorreu um erro em um Stream objeto ou TextReaderXmlReader durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

O Stream objeto ou TextReaderXmlReader foi fechado durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

Exemplos

O aplicativo de console a seguir inicia o processo de recuperação de um leitor de dados de forma assíncrona. Enquanto aguarda os resultados, esse aplicativo simples fica em um loop, investigando o valor da IsCompleted propriedade. Depois que o processo for concluído, o código recuperará o SqlDataReader e exibirá seu conteúdo.

Este exemplo também passa os CommandBehavior.CloseConnection valores e CommandBehavior.SingleRow no parâmetro de comportamento, fazendo com que a conexão seja fechada com o retornado SqlDataReader seja fechada e para otimizar para um único resultado de linha.

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

Comentários

O BeginExecuteReader método inicia o processo de execução assíncrona de uma instrução Transact-SQL ou um procedimento armazenado que retorna linhas, para que outras tarefas possam ser executadas simultaneamente enquanto a instrução está sendo executada. Quando a instrução for concluída, os desenvolvedores deverão chamar o EndExecuteReader método para concluir a operação e recuperar o SqlDataReader retornado pelo comando . O BeginExecuteReader método retorna imediatamente, mas até que o código execute a chamada de método correspondente EndExecuteReader , ele não deve executar nenhuma outra chamada que inicie uma execução síncrona ou assíncrona no mesmo SqlCommand objeto. Chamar o EndExecuteReader antes que a execução do comando seja concluída faz com que o SqlCommand objeto seja bloqueado até que a execução seja concluída.

O behavior parâmetro permite especificar opções que controlam o comportamento do comando e sua conexão. Esses valores podem ser combinados juntos (usando o operador da linguagem de OR programação); geralmente, os desenvolvedores usam o CommandBehavior.CloseConnection valor para garantir que a conexão seja fechada pelo runtime quando o SqlDataReader for fechado.

Observe que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se um comando grande ou muitos parâmetros forem enviados, esse método poderá ser bloqueado durante as gravações. Depois que o comando é enviado, o método retorna imediatamente sem aguardar uma resposta do servidor , ou seja, as leituras são assíncronas. Embora a execução de comando seja assíncrona, a busca de valor ainda é síncrona. Isso significa que as chamadas para Read poderão ser bloqueadas se mais dados forem necessários e os blocos de operação de leitura da rede subjacente.

Como essa sobrecarga não dá suporte a um procedimento de retorno de chamada, os desenvolvedores devem sondar para determinar se o comando foi concluído, usando a propriedade do IAsyncResult retornado pelo BeginExecuteNonQuery método ou aguardar a conclusão de um ou mais comandos usando a AsyncWaitHandle propriedade do retornadoIAsyncResult.IsCompleted

Se você usar ExecuteReader ou BeginExecuteReader acessar dados XML, SQL Server retornará qualquer resultado XML maior que 2.033 caracteres de comprimento em várias linhas de 2.033 caracteres cada. Para evitar esse comportamento, use ExecuteXmlReader ou BeginExecuteXmlReader leia consultas FOR XML.

Esse método ignora a CommandTimeout propriedade .

Aplica-se a

BeginExecuteReader(AsyncCallback, Object)

Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand e retorna resultados como um objeto XmlReader usando um procedimento de retorno de chamada.

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

Parâmetros

callback
AsyncCallback

Um delegado AsyncCallback invocado quando a execução do comando for concluída. Aprovadonull ( Nothing no Microsoft Visual Basic) para indicar que nenhum retorno de chamada é necessário.

stateObject
Object

Um objeto de estado definido pelo usuário passado para o procedimento de retorno de chamada. Recupere esse objeto de dentro do procedimento de retorno de chamada usando a propriedade AsyncState.

Retornos

Um IAsyncResult que pode ser usado para sondar, aguardar resultados ou ambos. Esse valor também é necessário ao chamar EndExecuteXmlReader(IAsyncResult), que retorna os resultados do comando como XML.

Exceções

Um SqlDbType diferente de Binary ou VarBinary foi usado quando Value foi definido como Stream . Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

- ou -

Um SqlDbType diferente de Char, NChar, NVarChar, VarChar ou Xml foi usado quando foi definido TextReader como Value .

-ou-

Um SqlDbType diferente de Xml foi usado quando Value foi definido XmlReader como .

Qualquer erro ocorrido ao executar o texto do comando.

- ou -

Ocorreu um tempo limite durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

O SqlConnection foi fechado ou removido durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do 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.

Ocorreu um erro em um Stream objeto ou TextReaderXmlReader durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

O Stream objeto ou TextReaderXmlReader foi fechado durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

Exemplos

O aplicativo do Windows a seguir demonstra o uso do método BeginExecuteXmlReader, executando uma instrução Transact-SQL que inclui um atraso de alguns segundos (emulando um comando de longa execução). Este exemplo passa o objeto em execução como o stateObject parâmetro – isso torna simples recuperar o SqlCommand objeto de dentro do procedimento de retorno de chamada, para que o código possa chamar o EndExecuteXmlReader método correspondente à chamada inicial para BeginExecuteXmlReader.SqlCommand

Este exemplo demonstra muitas técnicas importantes. Isso inclui chamar um método que interage com o formulário de um thread separado. Além disso, este exemplo demonstra como você deve impedir que os usuários executem um comando várias vezes simultaneamente e como você deve garantir que o formulário não seja fechado antes que o procedimento de retorno de chamada seja chamado.

Para configurar este exemplo, crie um aplicativo do Windows. Coloque um Button controle, um ListBox controle e um Label controle no formulário (aceitando o nome padrão para cada controle). Adicione o código a seguir à classe do formulário, modificando a cadeia de conexão conforme necessário para seu ambiente.

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

Comentários

O BeginExecuteXmlReader método inicia o processo de execução assíncrona de uma instrução Transact-SQL ou um procedimento armazenado que retorna linhas como XML, para que outras tarefas possam ser executadas simultaneamente enquanto a instrução está sendo executada. Quando a instrução for concluída, os desenvolvedores deverão chamar o EndExecuteXmlReader método para concluir a operação e recuperar os dados XML solicitados. O BeginExecuteXmlReader método retorna imediatamente, mas até que o código execute a chamada de método correspondente EndExecuteXmlReader , ele não deve executar nenhuma outra chamada que inicie uma execução síncrona ou assíncrona no mesmo SqlCommand objeto. Chamar o EndExecuteXmlReader antes que a execução do comando seja concluída faz com que o SqlCommand objeto seja bloqueado até que a execução seja concluída.

A CommandText propriedade normalmente especifica uma instrução Transact-SQL com uma cláusula FOR XML válida. No entanto, CommandText também pode especificar uma instrução que retorna dados que contêm XML válido. Esse método também pode ser usado para recuperar um conjunto de resultados de linha única e coluna única. Nesse caso, se mais de uma linha for retornada, o EndExecuteXmlReader método anexa o XmlReader ao valor na primeira linha e descarta o restante do conjunto de resultados.

Uma consulta típica BeginExecuteXmlReader pode ser formatada como no seguinte exemplo em C#:

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

Esse método também pode ser usado para recuperar um conjunto de resultados de linha única e coluna única. Nesse caso, se mais de uma linha for retornada, o EndExecuteXmlReader método anexa o XmlReader ao valor na primeira linha e descarta o restante do conjunto de resultados.

O recurso MARS (conjunto de resultados ativo múltiplo) permite que várias ações usem a mesma conexão.

O callback parâmetro permite especificar um AsyncCallback delegado que é chamado quando a instrução é concluída. Você pode chamar o EndExecuteXmlReader método de dentro desse procedimento delegado ou de qualquer outro local em seu aplicativo. Além disso, você pode passar qualquer objeto no parâmetro e o stateObject procedimento de retorno de chamada pode recuperar essas informações usando a AsyncState propriedade .

Observe que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se um comando grande ou muitos parâmetros for enviado, esse método poderá ser bloqueado durante gravações. Depois que o comando é enviado, o método retorna imediatamente sem aguardar uma resposta do servidor, ou seja, as leituras são assíncronas.

Todos os erros que ocorrem durante a execução da operação são gerados como exceções no procedimento de retorno de chamada. Você deve manipular a exceção no procedimento de retorno de chamada, não no aplicativo principal. Consulte o exemplo neste tópico para obter informações adicionais sobre como lidar com exceções no procedimento de retorno de chamada.

Se você usar ExecuteReader ou BeginExecuteReader para acessar dados XML, SQL Server retornará resultados XML maiores que 2.033 caracteres de comprimento em várias linhas de 2.033 caracteres cada. Para evitar esse comportamento, use ExecuteXmlReader ou BeginExecuteXmlReader para ler consultas FOR XML.

Esse método ignora a CommandTimeout propriedade .

Confira também

Aplica-se a

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand , usando um dosCommandBehavior valores e recuperação de um ou mais conjuntos de resultados do servidor, considerando um procedimento de retorno de chamada e informações de estado.

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

Parâmetros

callback
AsyncCallback

Um delegado AsyncCallback invocado quando a execução do comando for concluída. Aprovadonull ( Nothing no Microsoft Visual Basic) para indicar que nenhum retorno de chamada é necessário.

stateObject
Object

Um objeto de estado definido pelo usuário passado para o procedimento de retorno de chamada. Recupere esse objeto de dentro do procedimento de retorno de chamada usando a propriedade AsyncState.

behavior
CommandBehavior

Um dos valores CommandBehavior que indica opções de execução de instrução e recuperação de dados.

Retornos

Um IAsyncResult que pode ser usado para sondar ou aguardar resultados ou ambos; esse valor também é necessário ao invocar EndExecuteReader(IAsyncResult) , que retorna uma SqlDataReader instância que pode ser usada para recuperar as linhas retornadas.

Exceções

Um SqlDbType diferente de Binary ou VarBinary foi usado quando Value foi definido Stream como . Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

- ou -

Um SqlDbType diferente de Char, NChar, NVarChar, VarChar ou Xml foi usado quando foi definido TextReader como Value .

-ou-

Um SqlDbType diferente de Xml foi usado quando Value foi definido XmlReader como .

Qualquer erro ocorrido ao executar o texto do comando.

- ou -

Ocorreu um tempo limite durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

O SqlConnection foi fechado ou removido durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do 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.

Ocorreu um erro em um Stream objeto ou TextReaderXmlReader durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

O Stream objeto ou TextReaderXmlReader foi fechado durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

Exemplos

O aplicativo do Windows a seguir demonstra o uso do método BeginExecuteReader, executando uma instrução Transact-SQL que inclui um atraso de alguns segundos (emulando um comando de longa execução). Como o exemplo executa o comando de forma assíncrona, o formulário permanece responsivo enquanto aguarda os resultados. Este exemplo passa o objeto em execução como o stateObject parâmetro ; isso simplifica a SqlCommand recuperação do objeto de dentro do procedimento de retorno de chamada, para que o código possa chamar o EndExecuteReader método correspondente à chamada inicial para BeginExecuteReader.SqlCommand

Este exemplo demonstra muitas técnicas importantes. Isso inclui chamar um método que interage com o formulário de um thread separado. Além disso, este exemplo demonstra como você deve impedir que os usuários executem um comando várias vezes simultaneamente e como você deve garantir que o formulário não feche antes que o procedimento de retorno de chamada seja chamado.

Para configurar este exemplo, crie um aplicativo do Windows. Coloque um Button controle, um DataGridView controle e um Label controle no formulário (aceitando o nome padrão para cada controle). Adicione o código a seguir à classe do formulário, modificando a cadeia de conexão conforme necessário para seu ambiente.

Este exemplo passa o CommandBehavior.CloseConnection valor no behavior parâmetro , fazendo com que o retornado SqlDataReader feche automaticamente sua conexão quando ela é fechada.

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

Comentários

O BeginExecuteReader método inicia o processo de execução assíncrona de uma instrução Transact-SQL ou um procedimento armazenado que retorna linhas, para que outras tarefas possam ser executadas simultaneamente enquanto a instrução está em execução. Quando a instrução for concluída, os desenvolvedores deverão chamar o EndExecuteReader método para concluir a operação e recuperar o SqlDataReader retornado pelo comando . O BeginExecuteReader método retorna imediatamente, mas até que o código execute a chamada de método correspondente EndExecuteReader , ele não deve executar nenhuma outra chamada que inicie uma execução síncrona ou assíncrona no mesmo SqlCommand objeto. Chamar o EndExecuteReader antes que a execução do comando seja concluída faz com que o SqlCommand objeto seja bloqueado até que a execução seja concluída.

O callback parâmetro permite especificar um AsyncCallback delegado que é chamado quando a instrução é concluída. Você pode chamar o EndExecuteReader método de dentro desse procedimento delegado ou de qualquer outro local em seu aplicativo. Além disso, você pode passar qualquer objeto no parâmetro e o stateObject procedimento de retorno de chamada pode recuperar essas informações usando a AsyncState propriedade .

O behavior parâmetro permite especificar opções que controlam o comportamento do comando e sua conexão. Esses valores podem ser combinados (usando o operador da Or linguagem de programação); geralmente, os desenvolvedores usam o CloseConnection valor para garantir que a conexão seja fechada pelo runtime quando o SqlDataReader for fechado. Os desenvolvedores também podem otimizar o comportamento do SqlDataReader especificando o SingleRow valor quando é conhecido com antecedência que a instrução Transact-SQL ou procedimento armazenado retorna apenas uma única linha.

Observe que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se um comando grande ou muitos parâmetros forem enviados, esse método poderá ser bloqueado durante gravações. Depois que o comando é enviado, o método retorna imediatamente sem aguardar uma resposta do servidor, ou seja, as leituras são assíncronas. Embora a execução do comando seja assíncrona, a busca de valor ainda é síncrona. Isso significa que as chamadas para Read poderão ser bloqueadas se mais dados forem necessários e os blocos de operação de leitura da rede subjacente.

Como o procedimento de retorno de chamada é executado de dentro de um thread em segundo plano fornecido pelo Common Language Runtime do Microsoft .NET, é muito importante que você tome uma abordagem rigorosa para lidar com interações entre threads de dentro de seus aplicativos. Por exemplo, você não deve interagir com o conteúdo de um formulário de dentro do procedimento de retorno de chamada. Caso precise atualizar o formulário, você deve alternar de volta para o thread do formulário para fazer seu trabalho. O exemplo neste tópico demonstra esse comportamento.

Todos os erros que ocorrem durante a execução da operação são gerados como exceções no procedimento de retorno de chamada. Você deve manipular a exceção no procedimento de retorno de chamada, não no aplicativo principal. Consulte o exemplo neste tópico para obter informações adicionais sobre como lidar com exceções no procedimento de retorno de chamada.

Se você usar ExecuteReader ou BeginExecuteReader para acessar dados XML, SQL Server retornará resultados XML maiores que 2.033 caracteres de comprimento em várias linhas de 2.033 caracteres cada. Para evitar esse comportamento, use ExecuteXmlReader ou BeginExecuteXmlReader para ler consultas FOR XML.

Esse método ignora a CommandTimeout propriedade .

Aplica-se a