SqlCommand.BeginExecuteXmlReader Yöntem

Tanım

Ad Alanı:

Microsoft.Data.SqlClient

Bütünleştirilmiş Kod:

Microsoft.Data.SqlClient.dll

Paket:

Microsoft.Data.SqlClient v5.2.0

Aşırı Yüklemeler

BeginExecuteXmlReader()	Transact-SQL deyiminin veya bunun SqlCommand tarafından açıklanan saklı yordamın zaman uyumsuz yürütülmesini başlatır ve sonuçları bir XmlReader nesne olarak döndürür.
BeginExecuteXmlReader(AsyncCallback, Object)	Transact-SQL deyiminin veya bunun SqlCommand tarafından açıklanan saklı yordamın zaman uyumsuz yürütmesini başlatır ve sonuçları bir geri çağırma yordamı kullanarak bir XmlReader nesne olarak döndürür.

BeginExecuteXmlReader()

Transact-SQL deyiminin veya bunun SqlCommand tarafından açıklanan saklı yordamın zaman uyumsuz yürütülmesini başlatır ve sonuçları bir XmlReader nesne olarak döndürür.

public:
 IAsyncResult ^ BeginExecuteXmlReader();

public IAsyncResult BeginExecuteXmlReader();

member this.BeginExecuteXmlReader : unit -> IAsyncResult

Public Function BeginExecuteXmlReader () As IAsyncResult

Döndürülenler

IAsyncResult

IAsyncResult Sonuçları yoklamak veya beklemek için kullanılabilecek bir veya her ikisini birden; bu değer çağrılırken de gereklidir EndExecuteXmlReader , tek bir XML değeri döndürür.

Özel durumlar

InvalidCastException

SqlDbType olarak ayarlandığında Streamİkili veya VarBinary dışında bir değer kullanıldıValue. Akış hakkında daha fazla bilgi için bkz . SqlClient Akış Desteği.

-veya-

SqlDbType olarak ayarlandığında TextReaderChar, NChar, NVarChar, VarChar veya Xml dışında bir değer kullanıldıValue.

-veya-

olarak ayarlandığında XmlReader Xml dışında bir SqlDbType değer kullanıldıValue.

SqlException

Komut metni yürütülürken oluşan herhangi bir hata.

-veya-

Akış işlemi sırasında zaman aşımı oluştu. Akış hakkında daha fazla bilgi için bkz . SqlClient Akış Desteği.

InvalidOperationException

Akış SqlConnection işlemi sırasında kapatılan veya bırakılan. Akış hakkında daha fazla bilgi için bkz . SqlClient Akış Desteği.

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

IOException

Akış işlemi sırasında bir Stream veya XmlReaderTextReader nesnesinde hata oluştu. Akış hakkında daha fazla bilgi için bkz . SqlClient Akış Desteği.

ObjectDisposedException

, StreamXmlReader veya TextReader nesnesi bir akış işlemi sırasında kapatıldı. Akış hakkında daha fazla bilgi için bkz . SqlClient Akış Desteği.

Örnekler

Aşağıdaki konsol uygulaması XML verilerini zaman uyumsuz olarak alma işlemini başlatır. Sonuçları beklerken, bu basit uygulama bir döngüde yer alır ve özellik değerini araştırmaktadır IsCompleted . İşlem tamamlandıktan sonra kod XML'yi alır ve içeriğini görüntüler.

[!code-csharp[SqlCommand_BeginExecuteXmlReader#1](~/.. /sqlclient/doc/samples/SqlCommand_BeginExecuteXmlReader.cs)]

Açıklamalar

yöntemi, BeginExecuteXmlReader deyim yürütülürken diğer görevlerin eşzamanlı olarak çalışabilmesi için satırları XML olarak döndüren transact-SQL deyimini zaman uyumsuz olarak yürütme işlemini başlatır. deyimi tamamlandığında, geliştiricilerin EndExecuteXmlReader işlemi tamamlamak ve komutu tarafından döndürülen XML'yi almak için yöntemini çağırması gerekir. BeginExecuteXmlReader yöntemi hemen döndürür, ancak kod karşılık gelen EndExecuteXmlReader yöntem çağrısını yürütene kadar, aynı SqlCommand nesneye karşı zaman uyumlu veya zaman uyumsuz yürütme başlatan diğer çağrıları yürütmemelidir. Komutun yürütülmesi tamamlanmadan önce öğesini EndExecuteXmlReader çağırmak, yürütme tamamlanana kadar nesnesinin engellenmesine neden olur SqlCommand .

CommandText özelliği normalde geçerli bir FOR XML yan tümcesine sahip bir Transact-SQL deyimi belirtir. Ancak, CommandText geçerli XML içeren verileri döndüren ntext bir deyimi de belirtebilir.

Tipik BeginExecuteXmlReader bir sorgu aşağıdaki C# örneğinde olduğu gibi biçimlendirilebilir:

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

Bu yöntem tek satırlı, tek sütunlu sonuç kümesini almak için de kullanılabilir. Bu durumda, birden fazla satır döndürülürse, EndExecuteXmlReader yöntemi ilk satırdaki değere öğesini ekler XmlReader ve sonuç kümesinin geri kalanını atar.

Birden çok etkin sonuç kümesi (MARS) özelliği, birden çok eylemin aynı bağlantıyı kullanmasına olanak tanır.

Komut metninin ve parametrelerinin sunucuya zaman uyumlu olarak gönderildiğini unutmayın. Büyük bir komut veya çok sayıda parametre gönderilirse, bu yöntem yazma işlemleri sırasında engelleyebilir. Komut gönderildikten sonra, yöntem sunucudan yanıt beklemeden hemen döner; yani okumalar zaman uyumsuzdur. Komut yürütme zaman uyumsuz olsa da, değer getirme işlemi yine de zaman uyumludur.

Bu aşırı yükleme bir geri çağırma yordamını desteklemediğinden, geliştiricilerin komutun tamamlanıp tamamlanmadığını belirlemek için, yöntemi tarafından BeginExecuteXmlReader döndürülen özelliğini IAsyncResult kullanarak IsCompleted yoklaması veya döndürülen IAsyncResultözelliğini kullanarak AsyncWaitHandle bir veya daha fazla komutun tamamlanmasını beklemesi gerekir.

XML verilerine erişmek için veya BeginExecuteReader kullanırsanızExecuteReader, SQL Server her biri 2.033 karakterden oluşan birden çok satırda 2.033 karakterden uzun XML sonuçları döndürür. Bu davranışı önlemek için, FOR XML sorgularını okumak için veya BeginExecuteXmlReader kullanınExecuteXmlReader.

Bu yöntem özelliğini yoksayar CommandTimeout .

BeginExecuteXmlReader(AsyncCallback, Object)

Transact-SQL deyiminin veya bunun SqlCommand tarafından açıklanan saklı yordamın zaman uyumsuz yürütmesini başlatır ve sonuçları bir geri çağırma yordamı kullanarak bir XmlReader nesne olarak döndürür.

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

Parametreler

callback

AsyncCallback

AsyncCallback Komutun yürütülmesi tamamlandığında çağrılan bir temsilci. Başarılı null ( Nothing Microsoft Visual Basic'te) geri çağırma gerekmediğini belirtir.

stateObject

Object

Geri çağırma yordamına geçirilen kullanıcı tanımlı durum nesnesi. özelliğini kullanarak AsyncState geri çağırma yordamının içinden bu nesneyi alın.

Döndürülenler

IAsyncResult

IAsyncResult Yoklama yapmak, sonuçları beklemek veya her ikisini birden yapmak için kullanılabilecek bir; bu değer, komutun sonuçlarını XML olarak döndüren çağrıldığında EndExecuteXmlReader(IAsyncResult) da gereklidir.

Özel durumlar

InvalidCastException

SqlDbType olarak ayarlandığında Streamİkili veya VarBinary dışında bir değer kullanıldıValue. Akış hakkında daha fazla bilgi için bkz . SqlClient Akış Desteği.

-veya-

SqlDbType olarak ayarlandığında TextReaderChar, NChar, NVarChar, VarChar veya Xml dışında bir değer kullanıldıValue.

-veya-

olarak ayarlandığında XmlReader Xml dışında bir SqlDbType değer kullanıldıValue.

SqlException

Komut metni yürütülürken oluşan herhangi bir hata.

-veya-

Akış işlemi sırasında zaman aşımı oluştu. Akış hakkında daha fazla bilgi için bkz . SqlClient Akış Desteği.

InvalidOperationException

Akış SqlConnection işlemi sırasında kapatılan veya bırakılan. Akış hakkında daha fazla bilgi için bkz . SqlClient Akış Desteği.

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

IOException

Akış işlemi sırasında bir Stream veya XmlReaderTextReader nesnesinde hata oluştu. Akış hakkında daha fazla bilgi için bkz . SqlClient Akış Desteği.

ObjectDisposedException

, StreamXmlReader veya TextReader nesnesi bir akış işlemi sırasında kapatıldı. Akış hakkında daha fazla bilgi için bkz . SqlClient Akış Desteği.

Örnekler

Aşağıdaki Windows uygulaması, birkaç saniyelik bir gecikme (uzun süre çalışan bir komutu öykünme) içeren bir Transact-SQL deyimi yürüterek yönteminin kullanımını BeginExecuteXmlReader gösterir. Bu örnek, yürüten SqlCommand nesneyi parametresi olarak stateObject geçirir; bunu yaptığınızda, kodun ilk çağrısına BeginExecuteXmlReaderkarşılık gelen yöntemi çağırabilmesi EndExecuteXmlReader için geri çağırma yordamının içinden nesneyi almayı SqlCommand basitleştirir.

Bu örnekte birçok önemli teknik gösterilmektedir. Bu, formla ayrı bir iş parçacığından etkileşim kuran bir yöntemi çağırmayı içerir. Buna ek olarak, bu örnekte kullanıcıların bir komutu eşzamanlı olarak birden çok kez yürütmesini nasıl engellemeniz gerektiği ve geri çağırma yordamı çağrılmadan önce formun kapanmadığından nasıl emin olmanız gerektiği gösterilmektedir.

Bu örneği ayarlamak için yeni bir Windows uygulaması oluşturun. Forma bir Button denetim, bir ListBox denetim ve bir Label denetim koyun (her denetim için varsayılan adı kabul ederek). Aşağıdaki kodu formun sınıfına ekleyin ve bağlantı dizesini ortamınız için gerektiği gibi değiştirin.

// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.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. 

            return "Data Source=(local);Integrated Security=true;" +
            "Initial Catalog=AdventureWorks";
        }

        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);
        }
    }
}
// </Snippet1>

Açıklamalar

yöntemi, BeginExecuteXmlReader deyimi yürütülürken diğer görevlerin eşzamanlı olarak çalışabilmesi için satırları XML olarak döndüren transact-SQL deyimini veya saklı yordamı zaman uyumsuz olarak yürütme işlemini başlatır. deyimi tamamlandığında, geliştiricilerin EndExecuteXmlReader işlemi tamamlamak ve istenen XML verilerini almak için yöntemini çağırması gerekir. BeginExecuteXmlReader yöntemi hemen döndürür, ancak kod karşılık gelen EndExecuteXmlReader yöntem çağrısını yürütene kadar, aynı SqlCommand nesneye karşı zaman uyumlu veya zaman uyumsuz yürütme başlatan diğer çağrıları yürütmemelidir. Komutun yürütülmesi tamamlanmadan önce öğesini EndExecuteXmlReader çağırmak, yürütme tamamlanana kadar nesnesinin engellenmesine neden olur SqlCommand .

CommandText özelliği normalde geçerli bir FOR XML yan tümcesine sahip bir Transact-SQL deyimi belirtir. Ancak, CommandText geçerli XML içeren verileri döndüren bir deyimi de belirtebilir. Bu yöntem tek satırlı, tek sütunlu sonuç kümesini almak için de kullanılabilir. Bu durumda, birden fazla satır döndürülürse, EndExecuteXmlReader yöntemi ilk satırdaki değere öğesini ekler XmlReader ve sonuç kümesinin geri kalanını atar.

Tipik BeginExecuteXmlReader bir sorgu aşağıdaki C# örneğinde olduğu gibi biçimlendirilebilir:

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

Bu yöntem tek satırlı, tek sütunlu sonuç kümesini almak için de kullanılabilir. Bu durumda, birden fazla satır döndürülürse, EndExecuteXmlReader yöntemi ilk satırdaki değere öğesini ekler XmlReader ve sonuç kümesinin geri kalanını atar.

Birden çok etkin sonuç kümesi (MARS) özelliği, birden çok eylemin aynı bağlantıyı kullanmasına olanak tanır.

parametresi, callback deyimi tamamlandığında çağrılan bir AsyncCallback temsilci belirtmenizi sağlar. Yöntemini bu temsilci yordamından veya uygulamanızın içindeki başka bir konumdan çağırabilirsiniz EndExecuteXmlReader . Ayrıca parametresindeki stateObject herhangi bir nesneyi geçirebilirsiniz ve geri çağırma yordamınız özelliğini kullanarak AsyncState bu bilgileri alabilir.

Komut metninin ve parametrelerinin sunucuya zaman uyumlu olarak gönderildiğini unutmayın. Büyük bir komut veya çok sayıda parametre gönderilirse, bu yöntem yazma işlemleri sırasında engelleyebilir. Komut gönderildikten sonra, yöntem sunucudan yanıt beklemeden hemen döner; yani okumalar zaman uyumsuzdur.

İşlemin yürütülmesi sırasında oluşan tüm hatalar geri çağırma yordamında özel durumlar olarak oluşturulur. Özel durumu ana uygulamada değil, geri çağırma yordamında işlemeniz gerekir. Geri çağırma yordamındaki özel durumları işleme hakkında ek bilgi için bu konudaki örne bakın.

XML verilerine erişmek için veya BeginExecuteReader kullanırsanızExecuteReader, SQL Server her biri 2.033 karakterlik birden çok satırda 2.033 karakterden uzun xml sonuçları döndürür. Bu davranışı önlemek için, FOR XML sorgularını okumak için veya BeginExecuteXmlReader kullanınExecuteXmlReader.

Bu yöntem özelliğini yoksayar CommandTimeout .

Ayrıca bkz.

• EndExecuteXmlReader(IAsyncResult)
• ExecuteXmlReader()