SqlCommand.BeginExecuteXmlReader Metodo

Definizione

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e restituisce i risultati come oggetto XmlReader.

Overload

BeginExecuteXmlReader()

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e restituisce i risultati come oggetto XmlReader.

BeginExecuteXmlReader(AsyncCallback, Object)

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e restituisce i risultati come oggetto XmlReader usando una routine di callback.

BeginExecuteXmlReader()

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e restituisce i risultati come oggetto XmlReader.

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

Restituisce

IAsyncResult

Oggetto IAsyncResult che può essere usato per eseguire il polling, attendere i risultati o entrambe le operazioni. Questo valore è necessario anche per chiamare il metodo EndExecuteXmlReader, che restituisce un singolo valore XML.

Eccezioni

È stato usato un valore SqlDbType diverso da Binary o VarBinary quando Value era impostato su Stream. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

-oppure-

È stato usato un valore SqlDbType diverso da Char, NChar, NVarChar, VarChar o Xml quando Value era impostato su TextReader.

-oppure-

È stato usato un valore SqlDbType diverso da Xml quando Value era impostato su XmlReader.

Qualsiasi errore che si è verificato durante l'esecuzione del testo del comando.

-oppure-

Si è verificato un timeout durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

La coppia nome/valore "Asynchronous Processing=true" non è stata inclusa nella stringa di connessione che definisce la connessione per SqlCommand.

-oppure-

L'elemento SqlConnection chiuso o eliminato durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Errore nell'oggetto Stream, XmlReader o TextReader durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

L'oggetto Stream, XmlReader o TextReader è stato chiuso durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Esempio

L'applicazione console seguente avvia il processo di recupero dei dati XML in modo asincrono. In attesa dei risultati, questa semplice applicazione si trova in un ciclo, analizzando il IsCompleted valore della proprietà. Al termine del processo, il codice recupera il codice XML e ne visualizza il contenuto.

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

Commenti

Il metodo avvia il processo di esecuzione asincrona di un'istruzione Transact-SQL che restituisce righe come XML, in modo che altre attività possano essere eseguite contemporaneamente mentre l'istruzione è in BeginExecuteXmlReader esecuzione. Al termine dell'istruzione, gli sviluppatori devono chiamare il metodo per completare EndExecuteXmlReader l'operazione e recuperare il codice XML restituito dal comando. Il metodo viene restituito immediatamente, ma fino a quando il codice non esegue la chiamata al metodo corrispondente, non deve eseguire altre chiamate che avviano un'esecuzione sincrona o asincrona sullo BeginExecuteXmlReader EndExecuteXmlReader stesso SqlCommand oggetto. La chiamata a prima del completamento dell'esecuzione del comando causa il blocco EndExecuteXmlReader dell'oggetto fino al completamento SqlCommand dell'esecuzione.

La CommandText proprietà specifica in genere un'istruzione Transact-SQL con una clausola FOR XML valida. Tuttavia, CommandText può anche specificare un'istruzione che restituisce dati che contengono codice XML ntext valido.

Una BeginExecuteXmlReader query tipica può essere formattata come nell'esempio C# seguente:

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

Questo metodo può essere usato anche per recuperare un set di risultati a riga singola e a colonna singola. In questo caso, se vengono restituite più righe, il metodo associa l'oggetto al valore nella prima riga e rimuove il resto EndExecuteXmlReader XmlReader del set di risultati.

La funzionalità MARS (Multiple Active Result Set) consente a più azioni di usare la stessa connessione.

Si noti che il testo del comando e i parametri vengono inviati al server in modo sincrono. Se viene inviato un comando di grandi dimensioni o molti parametri, questo metodo può bloccarsi durante le operazioni di scrittura. Dopo l'invio del comando, il metodo restituisce immediatamente senza attendere una risposta dal server, ad esempio le letture sono asincrone. Anche se l'esecuzione del comando è asincrona, il recupero di valori è ancora sincrono.

Poiché questo overload non supporta una routine di callback, gli sviluppatori devono eseguire il polling per determinare se il comando è stato completato, usando la proprietà dell'oggetto restituito dal metodo oppure attendere il completamento di uno o più comandi usando la proprietà dell'oggetto IsCompleted IAsyncResult BeginExecuteXmlReader AsyncWaitHandle IAsyncResult restituito.

Se si usa o per accedere ai dati XML, SQL Server restituisce tutti i risultati XML di lunghezza superiore a 2.033 caratteri in più righe di ExecuteReader BeginExecuteReader 2.033 caratteri ciascuna. Per evitare questo comportamento, usare ExecuteXmlReader o per leggere query FOR BeginExecuteXmlReader XML.

Questo metodo ignora la CommandTimeout proprietà .

Vedi anche

Si applica a

BeginExecuteXmlReader(AsyncCallback, Object)

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e restituisce i risultati come oggetto XmlReader usando una routine di callback.

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

Parametri

callback
AsyncCallback

Delegato AsyncCallback richiamato al termine dell'esecuzione del comando. Passare null (Nothing in Microsoft Visual Basic) per indicare che non è necessario alcun callback.

stateObject
Object

Oggetto di stato definito dall'utente e passato alla routine di callback. Recuperare questo oggetto dalla routine di callback usando la proprietà AsyncState.

Restituisce

IAsyncResult

Oggetto IAsyncResult che può essere usato per eseguire il polling, attendere i risultati o entrambe le cose. Questo valore è necessario anche per chiamare il metodo EndExecuteXmlReader(IAsyncResult), che restituisce i risultati del comando come dati XML.

Eccezioni

È stato usato un valore SqlDbType diverso da Binary o VarBinary quando Value era impostato su Stream. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

-oppure-

È stato usato un valore SqlDbType diverso da Char, NChar, NVarChar, VarChar o Xml quando Value era impostato su TextReader.

-oppure-

È stato usato un valore SqlDbType diverso da Xml quando Value era impostato su XmlReader.

Qualsiasi errore che si è verificato durante l'esecuzione del testo del comando.

-oppure-

Si è verificato un timeout durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

La coppia nome/valore "Asynchronous Processing=true" non è stata inclusa nella stringa di connessione che definisce la connessione per SqlCommand.

-oppure-

L'elemento SqlConnection chiuso o eliminato durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Errore nell'oggetto Stream, XmlReader o TextReader durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

L'oggetto Stream, XmlReader o TextReader è stato chiuso durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Esempio

Nell'applicazione Windows seguente viene illustrato l'uso del metodo BeginExecuteXmlReader, eseguendo un'istruzione Transact-SQL che include un ritardo di pochi secondi (emulando un comando con esecuzione prolungata). Questo esempio passa l'oggetto in esecuzione come parametro. In questo modo è semplice recuperare l'oggetto dall'interno della SqlCommand stateObject routine di SqlCommand callback, in modo che il codice possa chiamare il metodo corrispondente alla EndExecuteXmlReader chiamata iniziale a BeginExecuteXmlReader .

Questo esempio illustra molte tecniche importanti. Ciò include la chiamata a un metodo che interagisce con il form da un thread separato. Questo esempio illustra anche come è necessario impedire agli utenti di eseguire un comando più volte contemporaneamente e come assicurarsi che il form non venga chiuso prima che venga chiamata la routine di callback.

Per impostare questo esempio, creare una nuova applicazione Windows. Inserire un Button controllo , un controllo e un controllo nel form ListBox Label (accettando il nome predefinito per ogni controllo). Aggiungere il codice seguente alla classe del form, modificando la stringa di connessione in base alle esigenze per l'ambiente.

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

Commenti

Il metodo avvia il processo di esecuzione asincrona di un'istruzione Transact-SQL o di un stored procedure che restituisce righe come XML, in modo che altre attività possano essere eseguite contemporaneamente mentre l'istruzione è BeginExecuteXmlReader in esecuzione. Al termine dell'istruzione, gli sviluppatori devono chiamare il EndExecuteXmlReader metodo per completare l'operazione e recuperare i dati XML richiesti. Il metodo viene restituito immediatamente, ma fino a quando il codice non esegue la chiamata al metodo corrispondente, non deve eseguire altre chiamate che avviano un'esecuzione sincrona o asincrona sullo BeginExecuteXmlReader EndExecuteXmlReader stesso SqlCommand oggetto. La chiamata a prima del completamento dell'esecuzione del comando causa il blocco EndExecuteXmlReader dell'oggetto fino al completamento SqlCommand dell'esecuzione.

La CommandText proprietà specifica in genere un'istruzione Transact-SQL con una clausola FOR XML valida. Tuttavia, CommandText può anche specificare un'istruzione che restituisce dati che contengono codice XML valido. Questo metodo può essere usato anche per recuperare un set di risultati a riga singola e a colonna singola. In questo caso, se vengono restituite più righe, il metodo associa l'oggetto al valore nella prima riga e rimuove il resto EndExecuteXmlReader XmlReader del set di risultati.

Una BeginExecuteXmlReader query tipica può essere formattata come nell'esempio C# seguente:

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

Questo metodo può essere usato anche per recuperare un set di risultati a riga singola e a colonna singola. In questo caso, se vengono restituite più righe, il metodo associa l'oggetto al valore nella prima riga e rimuove il resto EndExecuteXmlReader XmlReader del set di risultati.

La funzionalità MARS (Multiple Active Result Set) consente a più azioni di usare la stessa connessione.

Il callback parametro consente di specificare un delegato che viene chiamato al termine AsyncCallback dell'istruzione . È possibile chiamare il metodo dall'interno di questa routine delegato o da EndExecuteXmlReader qualsiasi altra posizione all'interno dell'applicazione. Inoltre, è possibile passare qualsiasi oggetto nel parametro e stateObject la routine di callback può recuperare queste informazioni usando la proprietà AsyncState .

Si noti che il testo del comando e i parametri vengono inviati al server in modo sincrono. Se viene inviato un comando di grandi dimensioni o molti parametri, questo metodo può bloccarsi durante le scritture. Dopo l'invio del comando, il metodo restituisce immediatamente senza attendere una risposta dal server, ad esempio le letture sono asincrone.

Tutti gli errori che si verificano durante l'esecuzione dell'operazione vengono generati come eccezioni nella procedura di callback. È necessario gestire l'eccezione nella procedura di callback, non nell'applicazione principale. Per altre informazioni sulla gestione delle eccezioni nella procedura di callback, vedere l'esempio in questo argomento.

Se si usa o per accedere ai dati XML, SQL Server restituirà tutti i risultati XML di lunghezza superiore a 2.033 caratteri in più righe di ExecuteReader BeginExecuteReader 2.033 caratteri ciascuna. Per evitare questo comportamento, usare ExecuteXmlReader o per leggere query FOR BeginExecuteXmlReader XML.

Questo metodo ignora la CommandTimeout proprietà .

Vedi anche

Si applica a