Udostępnij za pośrednictwem


SqlCommand.BeginExecuteXmlReader Metoda

Definicja

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym temacie SqlCommand i zwraca wyniki jako XmlReader obiekt.

Przeciążenia

BeginExecuteXmlReader()

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej, która jest opisana przez to SqlCommand i zwraca wyniki jako XmlReader obiekt.

BeginExecuteXmlReader(AsyncCallback, Object)

Inicjuje asynchroniczne wykonywanie instrukcji Języka Transact-SQL lub procedury składowanej opisanej przez tę SqlCommand metodę XmlReader i zwraca wyniki jako obiekt przy użyciu procedury wywołania zwrotnego.

BeginExecuteXmlReader()

Źródło:
System.Data.SqlClient.notsupported.cs

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej, która jest opisana przez to SqlCommand i zwraca wyniki jako XmlReader obiekt.

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

Zwraca

Element IAsyncResult , który może służyć do sondowania lub oczekiwania na wyniki albo obu. Ta wartość jest również potrzebna w przypadku wywołania EndExecuteXmlReadermetody , która zwraca pojedynczą wartość XML.

Wyjątki

Użyto SqlDbType wartości innej niż Binary lub VarBinary , gdy Value ustawiono wartość Stream. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

-lub-

Użyto SqlDbType wartości innej niż Char, NChar, NVarChar, VarChar lub Xml , gdy Value ustawiono wartość TextReader.

-lub-

Element SqlDbType inny niż Xml był używany, gdy Value został ustawiony na XmlReaderwartość .

Wszelkie błędy, które wystąpiły podczas wykonywania tekstu polecenia.

-lub-

Podczas operacji przesyłania strumieniowego wystąpiło przekroczenie limitu czasu. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

Para name/value "Asynchronous Processing=true" nie została uwzględniona w parametry połączenia definiując połączenie dla tego SqlCommandelementu .

-lub-

Zamknięty SqlConnection lub porzucony podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

Wystąpił błąd w StreamXmlReader obiekcie lub TextReader podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

XmlReader Obiekt Streamlub TextReader został zamknięty podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

Przykłady

Następująca aplikacja konsolowa uruchamia proces asynchronicznego pobierania danych XML. Podczas oczekiwania na wyniki ta prosta aplikacja znajduje się w pętli, badając IsCompleted wartość właściwości. Po zakończeniu procesu kod pobiera kod XML i wyświetla jego zawartość.

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

Uwagi

Metoda BeginExecuteXmlReader rozpoczyna proces asynchronicznego wykonywania instrukcji Języka Transact-SQL, która zwraca wiersze jako XML, aby inne zadania mogły być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteXmlReader , aby zakończyć operację i pobrać kod XML zwrócony przez polecenie . BeginExecuteXmlReader Metoda zwraca natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteXmlReader wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają synchroniczne lub asynchroniczne wykonywanie względem tego samego SqlCommand obiektu. EndExecuteXmlReader Wywołanie metody przed ukończeniem wykonywania polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.

Właściwość CommandText zwykle określa instrukcję Języka Transact-SQL z prawidłową klauzulą FOR XML. CommandText Można jednak również określić instrukcję, która zwraca ntext dane zawierające prawidłowy kod XML.

Typowe BeginExecuteXmlReader zapytanie można sformatować tak, jak w poniższym przykładzie w języku C#:

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

Tej metody można również użyć do pobrania zestawu wyników z jednym wierszem z jedną kolumną. W takim przypadku, jeśli zostanie zwrócony więcej niż jeden wiersz, EndExecuteXmlReader metoda dołącza XmlReader wartość do wartości w pierwszym wierszu i odrzuca resztę zestawu wyników.

Funkcja wielu aktywnych zestawów wyników (MARS) umożliwia korzystanie z tego samego połączenia przez wiele akcji.

Należy pamiętać, że tekst polecenia i parametry są wysyłane do serwera synchronicznie. Jeśli wysyłane jest duże polecenie lub wiele parametrów, ta metoda może blokować podczas zapisu. Po wysłaniu polecenia metoda zwraca natychmiast bez oczekiwania na odpowiedź z serwera — czyli operacje odczytu są asynchroniczne. Mimo że wykonywanie polecenia jest asynchroniczne, pobieranie wartości jest nadal synchroniczne.

Ponieważ to przeciążenie nie obsługuje procedury wywołania zwrotnego, deweloperzy muszą albo sondować, aby określić, czy polecenie zostało ukończone, przy użyciu IsCompleted właściwości IAsyncResult zwracanej przez BeginExecuteXmlReader metodę; lub poczekać na ukończenie co najmniej jednego polecenia przy użyciu AsyncWaitHandle właściwości zwróconej IAsyncResult.

Jeśli używasz ExecuteReader funkcji lub BeginExecuteReader do uzyskiwania dostępu do danych XML, SQL Server zwraca wyniki XML większe niż 2033 znaki w wielu wierszach o długości 2033 znaków. Aby uniknąć tego zachowania, użyj polecenia ExecuteXmlReader lub BeginExecuteXmlReader do odczytu dla zapytań XML.

Ta metoda ignoruje CommandTimeout właściwość .

Zobacz też

Dotyczy

BeginExecuteXmlReader(AsyncCallback, Object)

Źródło:
System.Data.SqlClient.notsupported.cs

Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym SqlCommand temacie i zwraca wyniki jako XmlReader obiekt przy użyciu procedury wywołania zwrotnego.

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

Delegat AsyncCallback wywoływany po zakończeniu wykonywania polecenia. Przekaż null element (Nothing w języku Microsoft Visual Basic), aby wskazać, że nie jest wymagane żadne wywołanie zwrotne.

stateObject
Object

Obiekt stanu zdefiniowany przez użytkownika, który jest przekazywany do procedury wywołania zwrotnego. Pobierz ten obiekt z procedury wywołania zwrotnego przy użyciu AsyncState właściwości .

Zwraca

Element IAsyncResult , który może służyć do sondowania, oczekiwania na wyniki lub obu. Ta wartość jest również potrzebna, gdy EndExecuteXmlReader(IAsyncResult) jest wywoływana, co zwraca wyniki polecenia jako XML.

Wyjątki

Użyto SqlDbType wartości innej niż Binary lub VarBinary , gdy Value ustawiono wartość Stream. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

-lub-

Użyto SqlDbType wartości innej niż Char, NChar, NVarChar, VarChar lub Xml , gdy Value ustawiono wartość TextReader.

-lub-

Element SqlDbType inny niż Xml był używany, gdy Value został ustawiony na XmlReaderwartość .

Wszelkie błędy, które wystąpiły podczas wykonywania tekstu polecenia.

-lub-

Podczas operacji przesyłania strumieniowego wystąpiło przekroczenie limitu czasu. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

Para name/value "Asynchronous Processing=true" nie została uwzględniona w parametry połączenia definiując połączenie dla tego SqlCommandelementu .

-lub-

Zamknięty SqlConnection lub porzucony podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

Wystąpił błąd w StreamXmlReader obiekcie lub TextReader podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

XmlReader Obiekt Streamlub TextReader został zamknięty podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.

Przykłady

Poniższa aplikacja systemu Windows demonstruje użycie BeginExecuteXmlReader metody , wykonując instrukcję Języka Transact-SQL, która zawiera opóźnienie kilku sekund (emulując długotrwałe polecenie). Ten przykład przekazuje obiekt wykonujący SqlCommand jako stateObject parametr — dzięki temu można łatwo pobrać SqlCommand obiekt z procedury wywołania zwrotnego, aby kod mógł wywołać EndExecuteXmlReader metodę odpowiadającą początkowemu wywołaniu metody BeginExecuteXmlReader.

W tym przykładzie pokazano wiele ważnych technik. Obejmuje to wywołanie metody, która wchodzi w interakcję z formularzem z oddzielnego wątku. Ponadto w tym przykładzie pokazano, jak należy zablokować użytkownikom wielokrotne wykonywanie polecenia jednocześnie oraz upewnić się, że formularz nie zamyka się przed wywołaniem procedury wywołania zwrotnego.

Aby skonfigurować ten przykład, utwórz nową aplikację systemu Windows. Umieść kontrolkę Button , kontrolkę ListBox i kontrolkę Label w formularzu (akceptując domyślną nazwę każdej kontrolki). Dodaj następujący kod do klasy formularza, modyfikując parametry połączenia zgodnie z potrzebami środowiska.

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

Uwagi

Metoda BeginExecuteXmlReader rozpoczyna proces asynchronicznego wykonywania instrukcji Języka Transact-SQL lub procedury składowanej, która zwraca wiersze jako XML, dzięki czemu inne zadania mogą być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteXmlReader , aby zakończyć operację i pobrać żądane dane XML. BeginExecuteXmlReader Metoda zwraca natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteXmlReader wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają synchroniczne lub asynchroniczne wykonywanie względem tego samego SqlCommand obiektu. EndExecuteXmlReader Wywołanie metody przed ukończeniem wykonywania polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.

Właściwość CommandText zwykle określa instrukcję Języka Transact-SQL z prawidłową klauzulą FOR XML. CommandText Można jednak również określić instrukcję, która zwraca dane zawierające prawidłowy kod XML. Tej metody można również użyć do pobrania zestawu wyników z jednym wierszem z jedną kolumną. W takim przypadku, jeśli zostanie zwrócony więcej niż jeden wiersz, EndExecuteXmlReader metoda dołącza XmlReader wartość do wartości w pierwszym wierszu i odrzuca resztę zestawu wyników.

Typowe BeginExecuteXmlReader zapytanie można sformatować tak, jak w poniższym przykładzie w języku C#:

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

Tej metody można również użyć do pobrania zestawu wyników z jednym wierszem z jedną kolumną. W takim przypadku, jeśli zostanie zwrócony więcej niż jeden wiersz, EndExecuteXmlReader metoda dołącza XmlReader wartość do wartości w pierwszym wierszu i odrzuca resztę zestawu wyników.

Funkcja wielu aktywnych zestawów wyników (MARS) umożliwia korzystanie z tego samego połączenia przez wiele akcji.

Parametr callback umożliwia określenie delegata AsyncCallback , który jest wywoływany po zakończeniu instrukcji. Metodę EndExecuteXmlReader można wywołać z poziomu tej procedury delegata lub z dowolnej innej lokalizacji w aplikacji. Ponadto można przekazać dowolny obiekt w parametrze stateObject , a procedura wywołania zwrotnego AsyncState może pobrać te informacje przy użyciu właściwości .

Należy pamiętać, że tekst polecenia i parametry są wysyłane do serwera synchronicznie. Jeśli jest wysyłane duże polecenie lub wiele parametrów, ta metoda może blokować podczas zapisu. Po wysłaniu polecenia metoda zwraca natychmiast bez oczekiwania na odpowiedź z serwera — czyli operacje odczytu są asynchroniczne.

Wszystkie błędy występujące podczas wykonywania operacji są zgłaszane jako wyjątki w procedurze wywołania zwrotnego. Należy obsłużyć wyjątek w procedurze wywołania zwrotnego, a nie w aplikacji głównej. Zobacz przykład w tym temacie, aby uzyskać dodatkowe informacje na temat obsługi wyjątków w procedurze wywołania zwrotnego.

Jeśli używasz ExecuteReader lub BeginExecuteReader uzyskujesz dostęp do danych XML, SQL Server zwróci wszystkie wyniki XML większe niż 2033 znaki w wielu wierszach o długości 2033 znaków. Aby uniknąć tego zachowania, użyj ExecuteXmlReader polecenia lub BeginExecuteXmlReader odczytu dla zapytań XML.

Ta metoda ignoruje CommandTimeout właściwość .

Zobacz też

Dotyczy