SqlCommand.BeginExecuteXmlReader Método

public:
 IAsyncResult ^ BeginExecuteXmlReader();

public IAsyncResult BeginExecuteXmlReader ();

member this.BeginExecuteXmlReader : unit -> IAsyncResult

Public Function BeginExecuteXmlReader () As IAsyncResult

Devoluciones

IAsyncResult que se puede utilizar para sondear y/o esperar los resultados; este valor también es necesario al invocar a EndExecuteXmlReader, que devuelve un valor XML único.

Excepciones

Ejemplos

La siguiente aplicación de consola inicia el proceso de recuperación de datos XML de forma asincrónica. Mientras espera los resultados, esta sencilla aplicación se encuentra en un bucle, investigando el valor de la IsCompleted propiedad. Una vez completado el proceso, el código recupera el XML y muestra su contenido.

using System.Data.SqlClient;
using System.Xml;

class Class1
{
    static void Main()
    {
        // This example is not terribly effective, 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 Name, ListPrice FROM Production.Product " +
            "WHERE ListPrice < 100 " +
            "FOR XML AUTO, XMLDATA";

        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))
        {
            SqlCommand command = new SqlCommand(commandText, connection);

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

            // Although it is not necessary, the following procedure
            // displays a counter in the console window, indicating that
            // the main thread is not blocked while awaiting the command
            // results.
            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);
            }

            XmlReader reader = command.EndExecuteXmlReader(result);
            DisplayProductInfo(reader);
        }
    }

    private static 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")
            {
                Console.WriteLine("{0}: {1:C}",
                    reader["Name"], Convert.ToSingle(reader["ListPrice"]));
            }
        }
    }

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

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

Imports System.Data.SqlClient
Imports System.Xml

Module Module1

    Sub Main()
        ' This example is not terribly effective, but it proves a point.
        ' The WAITFOR statement simply adds enough time to prove the 
        ' asynchronous nature of the command.
        Dim commandText As String = _
         "WAITFOR DELAY '00:00:03';" & _
         "SELECT Name, ListPrice FROM Production.Product " & _
         "WHERE ListPrice < 100 " & _
         "FOR XML AUTO, XMLDATA"

        RunCommandAsynchronously(commandText, GetConnectionString())

        Console.WriteLine("Press ENTER to continue.")
        Console.ReadLine()
    End Sub

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

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

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

                Using reader As XmlReader = command.EndExecuteXmlReader(result)
                    DisplayProductInfo(reader)
                End Using
            Catch ex As SqlException
                Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message)
            Catch ex As InvalidOperationException
                Console.WriteLine("Error: {0}", ex.Message)
            Catch ex As Exception
                ' You might want to pass these errors
                ' back out to the caller.
                Console.WriteLine("Error: {0}", ex.Message)
            End Try
        End Using
    End Sub

    Private Sub DisplayProductInfo(ByVal reader As XmlReader)
        ' 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" Then
                Console.WriteLine("{0}: {1:C}", _
                 reader("Name"), CSng(reader("ListPrice")))
            End If
        End While
    End Sub

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

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

Comentarios

El BeginExecuteXmlReader método inicia el proceso de ejecución asincrónica de una instrucción Transact-SQL que devuelve filas como XML, de modo que otras tareas se puedan ejecutar simultáneamente mientras se ejecuta la instrucción . Una vez completada la instrucción , los desarrolladores deben llamar al EndExecuteXmlReader método para finalizar la operación y recuperar el XML devuelto por el comando . El BeginExecuteXmlReader método devuelve inmediatamente, pero hasta que el código ejecuta la llamada al método correspondiente EndExecuteXmlReader , no debe ejecutar ninguna otra llamada que inicie una ejecución sincrónica o asincrónica en el mismo SqlCommand objeto. EndExecuteXmlReader Al llamar a antes de que se complete la ejecución del comando, el SqlCommand objeto se bloqueará hasta que finalice la ejecución.

Normalmente, la CommandText propiedad especifica una instrucción Transact-SQL con una cláusula FOR XML válida. Sin embargo, CommandText también puede especificar una instrucción que devuelva ntext datos que contengan XML válido.

Se puede dar formato a una consulta típica BeginExecuteXmlReader como en el ejemplo de C#siguiente:

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

Este método también se puede usar para recuperar un conjunto de resultados de una sola fila y una sola columna. En este caso, si se devuelve más de una fila, el EndExecuteXmlReader método adjunta el XmlReader al valor de la primera fila y descarta el resto del conjunto de resultados.

La característica conjunto de resultados activo múltiple (MARS) permite que varias acciones usen la misma conexión.

Tenga en cuenta que el texto del comando y los parámetros se envían al servidor de forma sincrónica. Si se envía un comando grande o muchos parámetros, este método puede bloquearse durante las escrituras. Una vez enviado el comando, el método devuelve inmediatamente sin esperar una respuesta del servidor, es decir, las lecturas son asincrónicas. Aunque la ejecución de comandos es asincrónica, la captura de valores sigue siendo sincrónica.

Dado que esta sobrecarga no admite un procedimiento de devolución de llamada, los desarrolladores deben sondear para determinar si el comando se ha completado, mediante la IsCompleted propiedad del IAsyncResult devuelto por el BeginExecuteXmlReader método; o esperar a que finalice uno o varios comandos mediante la AsyncWaitHandle propiedad del devuelto IAsyncResult.

Si usa ExecuteReader o BeginExecuteReader para obtener acceso a datos XML, SQL Server devuelve resultados XML mayores de 2033 caracteres de longitud en varias filas de 2033 caracteres cada uno. Para evitar este comportamiento, use ExecuteXmlReader o BeginExecuteXmlReader para leer consultas FOR XML.

Este método omite la CommandTimeout propiedad .

Consulte también

• Conexión y recuperación de datos en ADO.NET
• Uso del proveedor de datos de .NET Framework para SQL Server
• Información general de ADO.NET

public:
 IAsyncResult ^ BeginExecuteXmlReader(AsyncCallback ^ callback, System::Object ^ stateObject);

public IAsyncResult BeginExecuteXmlReader (AsyncCallback callback, object stateObject);

member this.BeginExecuteXmlReader : AsyncCallback * obj -> IAsyncResult

Public Function BeginExecuteXmlReader (callback As AsyncCallback, stateObject As Object) As IAsyncResult

Parámetros

Devoluciones

IAsyncResult que se puede utilizar para sondear y/o esperar los resultados; este valor también es necesario cuando se llama a EndExecuteXmlReader(IAsyncResult), que devuelve los resultados del comando como XML.

Excepciones

Ejemplos

La siguiente aplicación Windows muestra el uso del método BeginExecuteXmlReader, que ejecuta una instrucción Transact-SQL que incluye un retraso de unos pocos segundos (emulando un comando de ejecución prolongada). En este ejemplo se pasa el objeto en ejecución SqlCommand como stateObject parámetro, lo que hace que sea sencillo recuperar el SqlCommand objeto desde dentro del procedimiento de devolución de llamada, de modo que el código pueda llamar al EndExecuteXmlReader método correspondiente a la llamada inicial a BeginExecuteXmlReader.

En este ejemplo se muestran muchas técnicas importantes. Esto incluye llamar a un método que interactúa con el formulario desde un subproceso independiente. Además, en este ejemplo se muestra cómo se debe impedir que los usuarios ejecuten un comando varias veces simultáneamente y cómo debe asegurarse de que el formulario no se cierra antes de llamar al procedimiento de devolución de llamada.

Para configurar este ejemplo, cree una aplicación Windows. Coloque un Button control, un ListBox control y un Label control en el formulario (aceptando el nombre predeterminado para cada control). Agregue el código siguiente a la clase del formulario, modificando el cadena de conexión según sea necesario para su entorno.

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

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

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

Imports System.Data.SqlClient
Imports System.Xml

Public Class Form1
    ' 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 Sub DisplayInfoDelegate(ByVal Text As String)
    Private Delegate Sub DisplayReaderDelegate(ByVal reader As XmlReader)

    Private isExecuting As Boolean

    ' This example maintains the connection object 
    ' externally, so that it is available for closing.
    Private connection As SqlConnection

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

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

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

    Private Sub ClearProductInfo()
        ' Clear the list box.
        Me.ListBox1.Items.Clear()
    End Sub

    Private Sub DisplayProductInfo(ByVal reader As XmlReader)
        ' 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" Then
                Me.ListBox1.Items.Add(String.Format("{0}: {1:C}", _
                    reader("Name"), CSng(reader("ListPrice"))))
            End If
        End While
        DisplayStatus("Ready")
    End Sub

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

    Private Sub Button1_Click(ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button1.Click
        If isExecuting Then
            MessageBox.Show(Me, "Already executing. Please wait until the current query " & _
                "has completed.")
        Else
            Dim command As SqlCommand
            Try
                ClearProductInfo()
                DisplayStatus("Connecting...")
                connection = New SqlConnection(GetConnectionString())
                ' To emulate a long-running query, wait for 
                ' a few seconds before working with the data.
                Dim commandText As String = _
                    "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.
                Dim callback As New AsyncCallback(AddressOf HandleCallback)
                command.BeginExecuteXmlReader(callback, command)

            Catch ex As Exception
                isExecuting = False
                DisplayStatus(String.Format("Ready (last error: {0})", ex.Message))
                If connection IsNot Nothing Then
                    connection.Close()
                End If
            End Try
        End If
    End Sub

    Private Sub HandleCallback(ByVal result As IAsyncResult)
        Try
            ' Retrieve the original command object, passed
            ' to this procedure in the AsyncState property
            ' of the IAsyncResult parameter.
            Dim command As SqlCommand = CType(result.AsyncState, SqlCommand)
            Dim reader As XmlReader = 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. 
            Dim del As New DisplayReaderDelegate(AddressOf DisplayProductInfo)
            Me.Invoke(del, reader)

        Catch ex As Exception
            ' Because you are now running code in a separate thread, 
            ' if you do not handle the exception here, none of your other
            ' code catches the exception. Because 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:
            Me.Invoke(New DisplayInfoDelegate(AddressOf DisplayStatus), _
                String.Format("Ready(last error: {0}", ex.Message))
        Finally
            isExecuting = False
            If connection IsNot Nothing Then
                connection.Close()
            End If
        End Try
    End Sub
End Class

Comentarios

El BeginExecuteXmlReader método inicia el proceso de ejecutar de forma asincrónica una instrucción Transact-SQL o un procedimiento almacenado que devuelve filas como XML, de modo que otras tareas se puedan ejecutar simultáneamente mientras se ejecuta la instrucción. Una vez completada la instrucción , los desarrolladores deben llamar al EndExecuteXmlReader método para finalizar la operación y recuperar los datos XML solicitados. El BeginExecuteXmlReader método devuelve inmediatamente, pero hasta que el código ejecuta la llamada al método correspondiente EndExecuteXmlReader , no debe ejecutar ninguna otra llamada que inicie una ejecución sincrónica o asincrónica en el mismo SqlCommand objeto. EndExecuteXmlReader Al llamar a antes de que se complete la ejecución del comando, el SqlCommand objeto se bloqueará hasta que finalice la ejecución.

Normalmente, la CommandText propiedad especifica una instrucción Transact-SQL con una cláusula FOR XML válida. Sin embargo, CommandText también puede especificar una instrucción que devuelva datos que contengan XML válido. Este método también se puede usar para recuperar un conjunto de resultados de una sola fila y una sola columna. En este caso, si se devuelve más de una fila, el EndExecuteXmlReader método adjunta el XmlReader al valor de la primera fila y descarta el resto del conjunto de resultados.

Se puede dar formato a una consulta típica BeginExecuteXmlReader como en el ejemplo de C#siguiente:

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

Este método también se puede usar para recuperar un conjunto de resultados de una sola fila y una sola columna. En este caso, si se devuelve más de una fila, el EndExecuteXmlReader método adjunta el XmlReader al valor de la primera fila y descarta el resto del conjunto de resultados.

La característica conjunto de resultados activo múltiple (MARS) permite que varias acciones usen la misma conexión.

El callback parámetro permite especificar un AsyncCallback delegado al que se llama cuando la instrucción se ha completado. Puede llamar al EndExecuteXmlReader método desde dentro de este procedimiento delegado o desde cualquier otra ubicación dentro de la aplicación. Además, puede pasar cualquier objeto en el stateObject parámetro y el procedimiento de devolución de llamada puede recuperar esta información mediante la AsyncState propiedad .

Tenga en cuenta que el texto del comando y los parámetros se envían al servidor de forma sincrónica. Si se envía un comando grande o muchos parámetros, este método puede bloquearse durante las escrituras. Una vez enviado el comando, el método devuelve inmediatamente sin esperar una respuesta del servidor, es decir, las lecturas son asincrónicas.

Todos los errores que se producen durante la ejecución de la operación se producen como excepciones en el procedimiento de devolución de llamada. Debe controlar la excepción en el procedimiento de devolución de llamada, no en la aplicación principal. Consulte el ejemplo de este tema para obtener información adicional sobre el control de excepciones en el procedimiento de devolución de llamada.

Si usa ExecuteReader o BeginExecuteReader para acceder a datos XML, SQL Server devolverá resultados XML mayores de 2033 caracteres de longitud en varias filas de 2033 caracteres cada uno. Para evitar este comportamiento, use ExecuteXmlReader o BeginExecuteXmlReader para leer consultas FOR XML.

Este método omite la CommandTimeout propiedad .

Consulte también

• EndExecuteXmlReader(IAsyncResult)
• ExecuteXmlReader()
• Información general de ADO.NET