Sdílet prostřednictvím


SqlCommand.BeginExecuteXmlReader Metoda

Definice

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

Přetížení

Name Description
BeginExecuteXmlReader()

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

BeginExecuteXmlReader(AsyncCallback, Object)

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

BeginExecuteXmlReader()

Zdroj:
System.Data.SqlClient.notsupported.cs

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

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

Návraty

To IAsyncResult lze použít k dotazování nebo čekání na výsledky, nebo obojí; tato hodnota je také nutná při vyvolání EndExecuteXmlReader, která vrátí jednu hodnotu XML.

Výjimky

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

nebo

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

nebo

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

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

nebo

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

Dvojice name/value "Asynchronní zpracování=true" nebyla zahrnuta v připojovacím řetězci definujícím připojení pro toto SqlCommand.

nebo

Zavřený SqlConnection nebo ukončený během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

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

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

Příklady

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

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

Poznámky

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

Vlastnost CommandText obvykle určuje příkaz Transact-SQL s platnou klauzulí FOR XML. CommandText Můžete však také zadat příkaz, který vrací ntext data obsahující platné XML.

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

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

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

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

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

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

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

Tato metoda ignoruje CommandTimeout vlastnost.

Viz také

Platí pro

BeginExecuteXmlReader(AsyncCallback, Object)

Zdroj:
System.Data.SqlClient.notsupported.cs

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

public:
 IAsyncResult ^ 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

Parametry

callback
AsyncCallback

AsyncCallback Delegát, který je vyvolán po dokončení provádění příkazu. Předáním null (Nothing v jazyce Microsoft Visual Basic) označíte, že není vyžadováno žádné zpětné volání.

stateObject
Object

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

Návraty

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

Výjimky

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

nebo

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

nebo

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

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

nebo

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

Dvojice name/value "Asynchronní zpracování=true" nebyla zahrnuta v připojovacím řetězci definujícím připojení pro toto SqlCommand.

nebo

Zavřený SqlConnection nebo ukončený během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

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

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

Příklady

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

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

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

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.Windows.Forms
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

Poznámky

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

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

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

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

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

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

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

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

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

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

Tato metoda ignoruje CommandTimeout vlastnost.

Viz také

Platí pro