SqlCommand.BeginExecuteXmlReader Metod

Källa:

System.Data.SqlClient.notsupported.cs

public:
 IAsyncResult ^ BeginExecuteXmlReader();

public IAsyncResult BeginExecuteXmlReader();

member this.BeginExecuteXmlReader : unit -> IAsyncResult

Public Function BeginExecuteXmlReader () As IAsyncResult

Returer

En IAsyncResult som kan användas för att avsöka eller vänta på resultat, eller båda. Det här värdet behövs också när du anropar EndExecuteXmlReader, som returnerar ett enda XML-värde.

Undantag

Exempel

Följande konsolprogram startar processen med att hämta XML-data asynkront. I väntan på resultatet finns det här enkla programmet i en loop och undersöker egenskapsvärdet IsCompleted . När processen har slutförts hämtar koden XML-koden och visar dess innehåll.

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

Kommentarer

Metoden BeginExecuteXmlReader startar processen med att asynkront köra en Transact-SQL-instruktion som returnerar rader som XML, så att andra aktiviteter kan köras samtidigt medan instruktionen körs. När -instruktionen har slutförts måste utvecklare anropa EndExecuteXmlReader metoden för att slutföra åtgärden och hämta XML-koden som returneras av kommandot. Metoden BeginExecuteXmlReader returnerar omedelbart, men tills koden kör motsvarande EndExecuteXmlReader metodanrop får den inte köra några andra anrop som startar en synkron eller asynkron körning mot samma SqlCommand objekt. EndExecuteXmlReader Om du anropar innan kommandots körning har slutförts blockeras SqlCommand objektet tills körningen är klar.

Egenskapen CommandText anger vanligtvis en Transact-SQL-instruktion med en giltig FOR XML-sats. Kan dock CommandText också ange en instruktion som returnerar ntext data som innehåller giltig XML.

En typisk BeginExecuteXmlReader fråga kan formateras som i följande C#-exempel:

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

Den här metoden kan också användas för att hämta en resultatuppsättning med en rad och en kolumn. I det här fallet, om mer än en rad returneras, EndExecuteXmlReader kopplar XmlReader metoden till värdet på den första raden och tar bort resten av resultatuppsättningen.

Med funktionen flera aktiva resultatuppsättningar (MARS) kan flera åtgärder använda samma anslutning.

Observera att kommandotexten och parametrarna skickas synkront till servern. Om ett stort kommando eller många parametrar skickas kan den här metoden blockeras under skrivningar. När kommandot har skickats returnerar metoden omedelbart utan att vänta på ett svar från servern, dvs. läsningar är asynkrona. Även om kommandokörningen är asynkron är värdehämtning fortfarande synkron.

Eftersom den här överlagringen inte stöder en återanropsprocedur måste utvecklare antingen avsöka för att avgöra om kommandot har slutförts med IsCompleted hjälp av egenskapen för den IAsyncResult som returneras av BeginExecuteXmlReader metoden eller vänta tills ett eller flera kommandon har slutförts med egenskapen AsyncWaitHandle för den returnerade IAsyncResult.

Om du använder ExecuteReader eller BeginExecuteReader för att komma åt XML-data returnerar SQL Server xml-resultat som är större än 2 033 tecken långa på flera rader med 2 033 tecken vardera. Undvik det här beteendet genom att använda ExecuteXmlReader eller BeginExecuteXmlReader läsa FOR XML-frågor.

Den här metoden ignorerar egenskapen CommandTimeout .

Se även

• Ansluta och hämta data i ADO.NET
• Använder .NET Framework Data Provider för SQL Server
• översikt över ADO.NET

Källa:

System.Data.SqlClient.notsupported.cs

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

Parametrar

Returer

Ett IAsyncResult som kan användas för att avsöka, vänta på resultat eller båda. Det här värdet behövs också när EndExecuteXmlReader(IAsyncResult) anropas, vilket returnerar resultatet av kommandot som XML.

Undantag

Exempel

Följande Windows-program visar användningen av BeginExecuteXmlReader metoden och kör en Transact-SQL-instruktion som innehåller en fördröjning på några sekunder (emulering av ett tidskrävande kommando). I det här exemplet skickas det körbara SqlCommand objektet som stateObject parameter , vilket gör det enkelt att hämta SqlCommand objektet inifrån återanropsproceduren, så att koden kan anropa metoden EndExecuteXmlReader som motsvarar det första anropet till BeginExecuteXmlReader.

Det här exemplet visar många viktiga tekniker. Detta inkluderar att anropa en metod som interagerar med formuläret från en separat tråd. Dessutom visar det här exemplet hur du måste blockera användare från att köra ett kommando flera gånger samtidigt och hur du måste se till att formuläret inte stängs innan återanropsproceduren anropas.

Om du vill konfigurera det här exemplet skapar du ett nytt Windows-program. Placera en Button kontroll, en ListBox kontroll och en Label kontroll i formuläret (acceptera standardnamnet för varje kontroll). Lägg till följande kod i formulärets klass och ändra reťazec pripojenia efter behov för din miljö.

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

Kommentarer

Metoden BeginExecuteXmlReader startar processen med att asynkront köra en Transact-SQL-instruktion eller lagrad procedur som returnerar rader som XML, så att andra uppgifter kan köras samtidigt medan instruktionen körs. När instruktionen har slutförts måste utvecklare anropa EndExecuteXmlReader metoden för att slutföra åtgärden och hämta begärda XML-data. Metoden BeginExecuteXmlReader returnerar omedelbart, men tills koden kör motsvarande EndExecuteXmlReader metodanrop får den inte köra några andra anrop som startar en synkron eller asynkron körning mot samma SqlCommand objekt. EndExecuteXmlReader Om du anropar innan kommandots körning har slutförts blockeras SqlCommand objektet tills körningen är klar.

Egenskapen CommandText anger vanligtvis en Transact-SQL-instruktion med en giltig FOR XML-sats. Kan dock CommandText också ange en instruktion som returnerar data som innehåller giltig XML. Den här metoden kan också användas för att hämta en resultatuppsättning med en rad och en kolumn. I det här fallet, om mer än en rad returneras, EndExecuteXmlReader kopplar XmlReader metoden till värdet på den första raden och tar bort resten av resultatuppsättningen.

En typisk BeginExecuteXmlReader fråga kan formateras som i följande C#-exempel:

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

Den här metoden kan också användas för att hämta en resultatuppsättning med en rad och en kolumn. I det här fallet, om mer än en rad returneras, EndExecuteXmlReader kopplar XmlReader metoden till värdet på den första raden och tar bort resten av resultatuppsättningen.

Med funktionen flera aktiva resultatuppsättningar (MARS) kan flera åtgärder använda samma anslutning.

Med callback parametern kan du ange ett AsyncCallback ombud som anropas när -instruktionen har slutförts. Du kan anropa EndExecuteXmlReader metoden inifrån den här ombudsproceduren eller från någon annan plats i ditt program. Dessutom kan du skicka valfritt objekt i parametern stateObject och återanropsproceduren kan hämta den här informationen med hjälp av AsyncState egenskapen .

Observera att kommandotexten och parametrarna skickas synkront till servern. Om ett stort kommando eller många parametrar skickas kan den här metoden blockeras under skrivningar. När kommandot har skickats returnerar metoden omedelbart utan att vänta på ett svar från servern, dvs. läsningar är asynkrona.

Alla fel som uppstår under körningen av åtgärden utlöses som undantag i återanropsproceduren. Du måste hantera undantaget i återanropsproceduren, inte i huvudprogrammet. Mer information om hur du hanterar undantag i återanropsproceduren finns i exemplet i det här avsnittet.

Om du använder ExecuteReader eller BeginExecuteReader för att komma åt XML-data returnerar SQL Server xml-resultat som är större än 2 033 tecken långa på flera rader med 2 033 tecken vardera. Undvik det här beteendet genom att använda ExecuteXmlReader eller BeginExecuteXmlReader läsa FOR XML-frågor.

Den här metoden ignorerar egenskapen CommandTimeout .

Se även

• EndExecuteXmlReader(IAsyncResult)
• ExecuteXmlReader()
• översikt över ADO.NET