SqlCommand.BeginExecuteReader Yöntem

Tanım

Transact-SQL deyiminin veya bu SqlCommandtarafından açıklanan saklı yordamın zaman uyumsuz yürütmesini başlatır ve sunucudan bir veya daha fazla sonuç kümesi alır.

Aşırı Yüklemeler

BeginExecuteReader()

Transact-SQL deyiminin veya bu SqlCommandtarafından açıklanan saklı yordamın zaman uyumsuz yürütmesini başlatır ve sunucudan bir veya daha fazla sonuç kümesi alır.

BeginExecuteReader(CommandBehavior)

Değerlerden birini kullanarak transact-SQL deyiminin veya bunun SqlCommand tarafından açıklanan saklı yordamın zaman uyumsuz yürütülmesini CommandBehavior başlatır.

BeginExecuteReader(AsyncCallback, Object)

Bu SqlCommand tarafından açıklanan Transact-SQL deyiminin veya saklı yordamın zaman uyumsuz yürütmesini başlatır ve bir geri çağırma yordamı ve durum bilgileri verildiğinde sunucudan bir veya daha fazla sonuç kümesi alır.

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Transact-SQL deyiminin veya bu SqlCommandtarafından açıklanan saklı yordamın zaman uyumsuz yürütülmesini başlatır. Değerlerden birini CommandBehavior kullanarak ve bir geri çağırma yordamı ve durum bilgileri verildiğinde sunucudan bir veya daha fazla sonuç kümesi alır.

BeginExecuteReader()

Transact-SQL deyiminin veya bu SqlCommandtarafından açıklanan saklı yordamın zaman uyumsuz yürütmesini başlatır ve sunucudan bir veya daha fazla sonuç kümesi alır.

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

Döndürülenler

IAsyncResult Sonuçları yoklamak veya beklemek veya her ikisini birden yapmak için kullanılabilecek bir; bu değer, döndürülen satırları almak için kullanılabilecek bir SqlDataReader örnek döndüren çağrılırken EndExecuteReader(IAsyncResult)de gereklidir.

Özel durumlar

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 XmlReaderXml dışında bir SqlDbType değer kullanıldıValue.

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.

"Asynchronous Processing=true" ad/değer çifti, bu SqlCommandiçin bağlantıyı tanımlayan bağlantı dizesi dahil değildi.

-veya-

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.

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

, 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ı, zaman uyumsuz olarak veri okuyucu 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 tamamlanır tamamlanmaz kod öğesini alır SqlDataReader ve içeriğini görüntüler.

using System.Data.SqlClient;

class Class1
{
    static void Main()
    {
        // This is a simple example that demonstrates the usage of the
        // BeginExecuteReader functionality
        // The WAITFOR statement simply adds enough time to prove the
        // asynchronous nature of the command.
        string commandText =
            "WAITFOR DELAY '00:00:03';" +
            "SELECT LastName, FirstName FROM Person.Contact " +
            "WHERE LastName LIKE 'M%'";

        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))
        {
            try
            {
                SqlCommand command = new SqlCommand(commandText, connection);

                connection.Open();
                IAsyncResult result = command.BeginExecuteReader();

                // Although it is not necessary, the following code
                // 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)
                {
                    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.
                    System.Threading.Thread.Sleep(100);
                }

                using (SqlDataReader reader = command.EndExecuteReader(result))
                {
                    DisplayResults(reader);
                }
            }
            catch (SqlException ex)
            {
                Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message);
            }
            catch (InvalidOperationException ex)
            {
                Console.WriteLine("Error: {0}", ex.Message);
            }
            catch (Exception ex)
            {
                // You might want to pass these errors
                // back out to the caller.
                Console.WriteLine("Error: {0}", ex.Message);
            }
        }
    }

    private static void DisplayResults(SqlDataReader reader)
    {
        // Display the data within the reader.
        while (reader.Read())
        {
            // Display all the columns.
            for (int i = 0; i < reader.FieldCount; i++)
                Console.Write("{0} ", reader.GetValue(i));
            Console.WriteLine();
        }
    }

    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

Module Module1
    Sub Main()
        ' This is a simple example that demonstrates the usage of the 
        ' BeginExecuteReader functionality.
        ' 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 LastName, FirstName FROM Person.Contact " & _
         "WHERE LastName LIKE 'M%'"

        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.BeginExecuteReader()

                ' 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
                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

                ' Once the IAsyncResult object signals that it is done
                ' waiting for results, you can retrieve the results.
                Using reader As SqlDataReader = command.EndExecuteReader(result)
                    DisplayResults(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 DisplayResults(ByVal reader As SqlDataReader)
        ' Display the data within the reader.
        While reader.Read()
            ' Display all the columns.
            For i As Integer = 0 To reader.FieldCount - 1
                Console.Write("{0} ", reader.GetValue(i))
            Next
            Console.WriteLine()
        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

Açıklamalar

yöntemi, BeginExecuteReader deyimi yürütülürken diğer görevlerin eşzamanlı olarak çalışabilmesi için satır 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 EndExecuteReader işlemi tamamlamak ve komutu tarafından döndürüleni SqlDataReader almak için yöntemini çağırması gerekir. BeginExecuteReader yöntemi hemen döndürür, ancak kod karşılık gelen EndExecuteReader 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 EndExecuteReader çağırmak, yürütme tamamlanana kadar nesnesinin engellenmesine neden olur SqlCommand .

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, daha fazla veri gerektiğinde ve Read temel alınan ağın okuma işlemi engelleniyorsa çağrısının engel olabileceği anlamına gelir.

Bu aşırı yükleme bir geri çağırma yordamını desteklemediğinden, geliştiricilerin komutun tamamlanıp tamamlanmadığını belirlemek için yoklaması, yöntemi tarafından BeginExecuteReader döndürülen özelliğini IAsyncResult kullanarak IsCompleted 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 .

Ayrıca bkz.

Şunlara uygulanır

BeginExecuteReader(CommandBehavior)

Değerlerden birini kullanarak transact-SQL deyiminin veya bunun SqlCommand tarafından açıklanan saklı yordamın zaman uyumsuz yürütülmesini CommandBehavior başlatır.

public:
 IAsyncResult ^ BeginExecuteReader(System::Data::CommandBehavior behavior);
public IAsyncResult BeginExecuteReader (System.Data.CommandBehavior behavior);
member this.BeginExecuteReader : System.Data.CommandBehavior -> IAsyncResult
Public Function BeginExecuteReader (behavior As CommandBehavior) As IAsyncResult

Parametreler

behavior
CommandBehavior

CommandBehavior Deyim yürütme ve veri alma seçeneklerini gösteren değerlerden biri.

Döndürülenler

IAsyncResult Yoklama yapmak, sonuçları beklemek veya her ikisini birden yapmak için kullanılabilecek bir; bu değer, döndürülen satırları almak için kullanılabilecek bir SqlDataReader örnek döndüren çağrılırken EndExecuteReader(IAsyncResult)de gereklidir.

Özel durumlar

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 XmlReaderXml dışında bir SqlDbType değer kullanıldıValue.

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.

"Asynchronous Processing=true" ad/değer çifti, bu SqlCommandiçin bağlantıyı tanımlayan bağlantı dizesi dahil değildi.

-veya-

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.

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

, 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ı, zaman uyumsuz olarak veri okuyucu 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 öğesini alır SqlDataReader ve içeriğini görüntüler.

Bu örnek ayrıca davranış parametresindeki CommandBehavior.CloseConnection ve CommandBehavior.SingleRow değerlerini geçirir ve döndürülen SqlDataReader ile bağlantının kapatılmasına ve tek bir satır sonucu için iyileştirme yapılmasına neden olur.

using System.Data.SqlClient;
class Class1
{
    static void Main()
    {
        // This example is not terribly useful, 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 ProductID, Name FROM Production.Product WHERE ListPrice < 100";

        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.

        try
        {
            // The code does not need to handle closing the connection explicitly--
            // the use of the CommandBehavior.CloseConnection option takes care
            // of that for you.
            SqlConnection connection = new SqlConnection(connectionString);
            SqlCommand command = new SqlCommand(commandText, connection);

            connection.Open();
            IAsyncResult result = command.BeginExecuteReader(
                CommandBehavior.CloseConnection);

            // Although it is not necessary, the following code
            // 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);
            }

            using (SqlDataReader reader = command.EndExecuteReader(result))
            {
                DisplayResults(reader);
            }
        }
        catch (SqlException ex)
        {
            Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message);
        }
        catch (InvalidOperationException ex)
        {
            Console.WriteLine("Error: {0}", ex.Message);
        }
        catch (Exception ex)
        {
            // You might want to pass these errors
            // back out to the caller.
            Console.WriteLine("Error: {0}", ex.Message);
        }
    }

    private static void DisplayResults(SqlDataReader reader)
    {
        // Display the data within the reader.
        while (reader.Read())
        {
            // Display all the columns.
            for (int i = 0; i < reader.FieldCount; i++)
            {
                Console.Write("{0}\t", reader.GetValue(i));
            }
            Console.WriteLine();
        }
    }

    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

Module Module1
    Sub Main()
        ' This example is not terribly useful, 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 ProductID, Name FROM Production.Product WHERE ListPrice < 100"

        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. 
        Try
            ' The code does not need to handle closing the connection explicitly--
            ' the use of the CommandBehavior.CloseConnection option takes care
            ' of that for you. 
            Dim connection As New SqlConnection(connectionString)
            Dim command As New SqlCommand(commandText, connection)

            connection.Open()
            Dim result As IAsyncResult = _
              command.BeginExecuteReader(CommandBehavior.CloseConnection)

            ' Although it is not necessary, the following code
            ' 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

            ' The "using" statement closes the SqlDataReader when it is 
            ' done executing.
            Using reader As SqlDataReader = command.EndExecuteReader(result)
                DisplayResults(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 Sub

    Private Sub DisplayResults(ByVal reader As SqlDataReader)
        ' Display the data within the reader.
        While reader.Read()
            ' Display all the columns. 
            For i As Integer = 0 To reader.FieldCount - 1
                Console.Write("{0} ", reader.GetValue(i))
            Next
            Console.WriteLine()
        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

Açıklamalar

yöntemi, BeginExecuteReader deyimi yürütülürken diğer görevlerin eşzamanlı olarak çalışabilmesi için satır 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 EndExecuteReader işlemi tamamlamak ve komutu tarafından döndürüleni SqlDataReader almak için yöntemini çağırması gerekir. BeginExecuteReader yöntemi hemen döndürür, ancak kod karşılık gelen EndExecuteReader 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 EndExecuteReader çağırmak, yürütme tamamlanana kadar nesnesinin engellenmesine neden olur SqlCommand .

parametresi, behavior komutun davranışını ve bağlantısını denetleyebilen seçenekleri belirtmenize olanak tanır. Bu değerler birlikte birleştirilebilir (programlama dilinin OR işleci kullanılarak); genellikle geliştiriciler, kapatıldığında SqlDataReader bağlantının çalışma zamanı tarafından kapatıldığından emin olmak için değerini kullanırCommandBehavior.CloseConnection.

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, daha fazla veri gerektiğinde ve Read temel alınan ağın okuma işlemi engelleniyorsa çağrısının engel olabileceği anlamına gelir.

Bu aşırı yükleme bir geri çağırma yordamını desteklemediğinden, geliştiricilerin komutun tamamlanıp tamamlanmadığını belirlemek için yoklaması, yöntemi tarafından BeginExecuteNonQuery döndürülen özelliğini IAsyncResult kullanarak IsCompleted 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 .

Ayrıca bkz.

Şunlara uygulanır

BeginExecuteReader(AsyncCallback, Object)

Bu SqlCommand tarafından açıklanan Transact-SQL deyiminin veya saklı yordamın zaman uyumsuz yürütmesini başlatır ve bir geri çağırma yordamı ve durum bilgileri verildiğinde sunucudan bir veya daha fazla sonuç kümesi alır.

public:
 IAsyncResult ^ BeginExecuteReader(AsyncCallback ^ callback, System::Object ^ stateObject);
public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject);
member this.BeginExecuteReader : AsyncCallback * obj -> IAsyncResult
Public Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object) As IAsyncResult

Parametreler

callback
AsyncCallback

AsyncCallback Komutun yürütülmesi tamamlandığında çağrılan bir temsilci. Nothing Geri çağırma gerekmediğini belirtmek için (Microsoft Visual Basic'te) geçirin null .

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 Yoklama yapmak, sonuçları beklemek veya her ikisini birden yapmak için kullanılabilecek bir; bu değer, döndürülen satırları almak için kullanılabilecek bir SqlDataReader örnek döndüren çağrılırken EndExecuteReader(IAsyncResult)de gereklidir.

Özel durumlar

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 XmlReaderXml dışında bir SqlDbType değer kullanıldıValue.

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.

"Asynchronous Processing=true" ad/değer çifti, bu SqlCommandiçin bağlantıyı tanımlayan bağlantı dizesi dahil değildi.

-veya-

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.

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

, 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 BeginExecuteReader ) içeren bir Transact-SQL deyimi yürüterek yönteminin kullanımını gösterir. Örnek komutu zaman uyumsuz olarak yürüttüğünden, form sonuçları beklerken yanıt vermeye devam eder. Bu örnek yürüten SqlCommand nesneyi parametresi olarak stateObject geçirir; bunu yaptığınızda, kodun ilk çağrısına SqlCommandBeginExecuteReaderkarşılık gelen yöntemi çağırabilmesi EndExecuteReader için geri çağırma yordamının içinden nesnenin alınması kolaylaşır.

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 DataGridView denetim ve bir Label denetim koyun (her denetim için varsayılan adı kabul ederek). Ortamınız için gereken bağlantı dizesi değiştirerek formun sınıfına aşağıdaki kodu ekleyin.

using System.Data.SqlClient;

namespace Microsoft.AdoDotNet.CodeSamples
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        // Hook up the form's Load event handler (you can double-click on
        // the form's design surface in Visual Studio), and then add
        // this code to the form's class:

        // You need this delegate in order to fill the grid from
        // a thread other than the form's thread. See the HandleCallback
        // procedure for more information.
        private delegate void FillGridDelegate(SqlDataReader reader);

        // You need this delegate to update the status bar.
        private delegate void DisplayStatusDelegate(string Text);

        // This flag ensures that the user does not attempt
        // to restart the command or close the form while the
        // asynchronous command is executing.
        private bool isExecuting = false;

        // Because the overloaded version of BeginExecuteReader
        // demonstrated here does not allow you to have the connection
        // closed automatically, this example maintains the
        // connection object externally, so that it is available for closing.
        private SqlConnection connection = null;

        private void DisplayStatus(string Text)
        {
            this.label1.Text = Text;
        }

        private void FillGrid(SqlDataReader reader)
        {
            try
            {
                DataTable table = new DataTable();
                table.Load(reader);
                this.dataGridView1.DataSource = table;
                DisplayStatus("Ready");
            }
            catch (Exception ex)
            {
                // Because you are guaranteed this procedure
                // is running from within the form's thread,
                // it can directly interact with members of the form.
                DisplayStatus(string.Format("Ready (last attempt failed: {0})",
                    ex.Message));
            }
            finally
            {
                // Do not forget to close the connection, as well.
                if (reader != null)
                {
                    reader.Close();
                }
                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;
                SqlDataReader reader = command.EndExecuteReader(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. Therefore you cannot simply call code that
                // fills the grid, like this:
                // FillGrid(reader);
                // 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.
                FillGridDelegate del = new FillGridDelegate(FillGrid);
                this.Invoke(del, reader);
                // Do not close the reader here, because it is being used in
                // a separate thread. Instead, have the procedure you have
                // called close the reader once it is done with it.
            }
            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 there is none of
                // your code 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 DisplayStatusDelegate(DisplayStatus),
                    "Error: " + ex.Message);
            }
            finally
            {
                isExecuting = false;
            }
        }

        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 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
                {
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());
                    // To emulate a long-running query, wait for
                    // a few seconds before retrieving the real data.
                    command = new SqlCommand("WAITFOR DELAY '0:0:5';" +
                        "SELECT ProductID, Name, ListPrice, Weight FROM Production.Product",
                        connection);
                    connection.Open();

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the
                    // SqlCommand object as the second parameter in the
                    // BeginExecuteReader call, doing so makes it easier
                    // to call EndExecuteReader in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteReader(callback, command);
                }
                catch (Exception ex)
                {
                    DisplayStatus("Error: " + ex.Message);
                    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 FormClosingEventHandler(Form1_FormClosing);
        }

        void Form1_FormClosing(object sender, FormClosingEventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this, "Cannot close the form until " +
                    "the pending asynchronous command has completed. Please wait...");
                e.Cancel = true;
            }
        }
    }
}
Imports System.Data.SqlClient

Public Class Form1
    ' Add this code to the form's class:
    ' You need this delegate in order to fill the grid from
    ' a thread other than the form's thread. See the HandleCallback
    ' procedure for more information.
    Private Delegate Sub FillGridDelegate(ByVal reader As SqlDataReader)

    ' You need this delegate to update the status bar.
    Private Delegate Sub DisplayStatusDelegate(ByVal Text As String)

    ' This flag ensures that the user does not attempt
    ' to restart the command or close the form while the 
    ' asynchronous command is executing.
    Private isExecuting As Boolean

    ' Because the overloaded version of BeginExecuteReader
    ' demonstrated here does not allow you to have the connection
    ' closed automatically, this example maintains the 
    ' connection object externally, so that it is available for closing.
    Private connection As SqlConnection

    Private Sub DisplayStatus(ByVal Text As String)
        Me.Label1.Text = Text
    End Sub

    Private Sub FillGrid(ByVal reader As SqlDataReader)
        Try
            Dim table As New DataTable
            table.Load(reader)
            Me.DataGridView1.DataSource = table
            DisplayStatus("Ready")

        Catch ex As Exception
            ' Because you are guaranteed this procedure
            ' is running from within the form's thread,
            ' it can directly interact with members of the form.
            DisplayStatus(String.Format("Ready (last attempt failed: {0})", ex.Message))
        Finally
            ' Do not forget to close the connection, as well.
            If Not reader Is Nothing Then
                reader.Close()
            End If
            If Not connection Is Nothing Then
                connection.Close()
            End If
        End Try
    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 SqlDataReader = command.EndExecuteReader(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. Therefore you cannot simply call code that 
            ' fills the grid, like this:
            ' FillGrid(reader)

            ' 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 FillGridDelegate(AddressOf FillGrid)
            Me.Invoke(del, reader)
            ' Do not close the reader here, because it is being used in 
            ' a separate thread. Instead, have the procedure you have
            ' called close the reader once it is done with it.

        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 there is none of 
            ' your code 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 DisplayStatusDelegate(AddressOf DisplayStatus), _
             "Error: " & ex.Message)
        Finally
            isExecuting = False
        End Try
    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 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"
    End Function

    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
                DisplayStatus("Connecting...")
                connection = New SqlConnection(GetConnectionString())
                ' To emulate a long-running query, wait for 
                ' a few seconds before retrieving the real data.
                command = New SqlCommand( _
                 "WAITFOR DELAY '0:0:5';" & _
                 "SELECT ProductID, Name, ListPrice, Weight FROM Production.Product", _
                 connection)
                connection.Open()

                DisplayStatus("Executing...")
                isExecuting = True
                ' Although it is not required that you pass the 
                ' SqlCommand object as the second parameter in the 
                ' BeginExecuteReader call, doing so makes it easier
                ' to call EndExecuteReader in the callback procedure.
                Dim callback As New AsyncCallback(AddressOf HandleCallback)
                command.BeginExecuteReader(callback, command)

            Catch ex As Exception
                DisplayStatus("Error: " & ex.Message)
                If connection IsNot Nothing Then
                    connection.Close()
                End If
            End Try
        End If
    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
End Class

Açıklamalar

yöntemi, BeginExecuteReader deyimi yürütülürken diğer görevlerin eşzamanlı olarak çalışabilmesi için satır 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 EndExecuteReader işlemi tamamlamak ve komutu tarafından döndürüleni SqlDataReader almak için yöntemini çağırması gerekir. BeginExecuteReader yöntemi hemen döndürür, ancak kod karşılık gelen EndExecuteReader 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 EndExecuteReader çağırmak, yürütme tamamlanana kadar nesnenin SqlCommand engellenmesine neden olur.

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 EndExecuteReader . 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. Komut yürütme zaman uyumsuz olsa da, değer getirme işlemi yine de zaman uyumludur. Bu, daha fazla veri gerektiğinde ve Read temel alınan ağın okuma işlemi engelleniyorsa çağrısının engel olabileceği anlamına gelir.

Geri çağırma yordamı Microsoft .NET çalışma zamanı tarafından sağlanan bir arka plan iş parçacığı içinden yürütülür, çünkü uygulamalarınızdan iş parçacıkları arası etkileşimleri işlemek için sıkı bir yaklaşım benimsemeniz çok önemlidir. Örneğin, bir formun içeriğiyle geri çağırma yordamınızdan etkileşim kurmamalısınız; formu güncelleştirmeniz gerekiyorsa, işinizi yapmak için formun iş parçacığına geri dönmeniz gerekir. Bu konudaki örnekte bu davranış gösterilmektedir.

İş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 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 .

Ayrıca bkz.

Şunlara uygulanır

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Transact-SQL deyiminin veya bu SqlCommandtarafından açıklanan saklı yordamın zaman uyumsuz yürütülmesini başlatır. Değerlerden birini CommandBehavior kullanarak ve bir geri çağırma yordamı ve durum bilgileri verildiğinde sunucudan bir veya daha fazla sonuç kümesi alır.

public:
 IAsyncResult ^ BeginExecuteReader(AsyncCallback ^ callback, System::Object ^ stateObject, System::Data::CommandBehavior behavior);
public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject, System.Data.CommandBehavior behavior);
member this.BeginExecuteReader : AsyncCallback * obj * System.Data.CommandBehavior -> IAsyncResult
Public Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object, behavior As CommandBehavior) As IAsyncResult

Parametreler

callback
AsyncCallback

AsyncCallback Komutun yürütülmesi tamamlandığında çağrılan bir temsilci. Nothing Geri çağırma gerekmediğini belirtmek için (Microsoft Visual Basic'te) geçirin null .

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.

behavior
CommandBehavior

CommandBehavior Deyim yürütme ve veri alma seçeneklerini gösteren değerlerden biri.

Döndürülenler

IAsyncResult Sonuçları yoklamak veya beklemek için veya her ikisini birden yapmak için kullanılabilecek bir; bu değer, döndürülen satırları almak için kullanılabilecek bir SqlDataReader örnek döndüren çağrılırken EndExecuteReader(IAsyncResult)de gereklidir.

Özel durumlar

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 XmlReaderXml dışında bir SqlDbType değer kullanıldıValue.

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.

"Asynchronous Processing=true" ad/değer çifti, bu SqlCommandiçin bağlantıyı tanımlayan bağlantı dizesi dahil değildi.

-veya-

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.

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

, 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 BeginExecuteReader ) içeren bir Transact-SQL deyimi yürüterek yönteminin kullanımını gösterir. Örnek komutu zaman uyumsuz olarak yürüttüğünden, form sonuçları beklerken yanıt vermeye devam eder. Bu örnek yürüten SqlCommand nesneyi parametresi olarak stateObject geçirir; bunu yaptığınızda, kodun ilk çağrısına SqlCommandBeginExecuteReaderkarşılık gelen yöntemi çağırabilmesi EndExecuteReader için geri çağırma yordamının içinden nesnenin alınması kolaylaşır.

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 DataGridView denetim ve bir Label denetim koyun (her denetim için varsayılan adı kabul ederek). Ortamınız için gereken bağlantı dizesi değiştirerek formun sınıfına aşağıdaki kodu ekleyin.

Bu örnek parametresindeki CommandBehavior.CloseConnectionbehavior değeri geçirir ve döndürülen SqlDataReader değerin kapatıldığında otomatik olarak bağlantısını kapatmasına neden olur.

using System.Data.SqlClient;

namespace Microsoft.AdoDotNet.CodeSamples
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
        // Hook up the form's Load event handler (you can double-click on
        // the form's design surface in Visual Studio), and then add
        // this code to the form's class:
        // You need this delegate in order to fill the grid from
        // a thread other than the form's thread. See the HandleCallback
        // procedure for more information.
        private delegate void FillGridDelegate(SqlDataReader reader);

        // You need this delegate to update the status bar.
        private delegate void DisplayStatusDelegate(string Text);

        // This flag ensures that the user does not attempt
        // to restart the command or close the form while the
        // asynchronous command is executing.
        private bool isExecuting;

        private void DisplayStatus(string Text)
        {
            this.label1.Text = Text;
        }

        private void FillGrid(SqlDataReader reader)
        {
            try
            {
                DataTable table = new DataTable();
                table.Load(reader);
                this.dataGridView1.DataSource = table;
                DisplayStatus("Ready");
            }
            catch (Exception ex)
            {
                // Because you are guaranteed this procedure
                // is running from within the form's thread,
                // it can directly interact with members of the form.
                DisplayStatus(string.Format("Ready (last attempt failed: {0})",
                    ex.Message));
            }
            finally
            {
                // Closing the reader also closes the connection,
                // because this reader was created using the
                // CommandBehavior.CloseConnection value.
                if (reader != null)
                {
                    reader.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;
                SqlDataReader reader = command.EndExecuteReader(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. Therefore you cannot simply call code that
                // fills the grid, like this:
                // FillGrid(reader);
                // 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.
                FillGridDelegate del = new FillGridDelegate(FillGrid);
                this.Invoke(del, reader);
                // Do not close the reader here, because it is being used in
                // a separate thread. Instead, have the procedure you have
                // called close the reader once it is done with it.
            }
            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 there is none of
                // your code 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 DisplayStatusDelegate(DisplayStatus), "Error: " +
                    ex.Message);
            }
            finally
            {
                isExecuting = false;
            }
        }

        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 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;
                SqlConnection connection = null;
                try
                {
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());
                    // To emulate a long-running query, wait for
                    // a few seconds before retrieving the real data.
                    command = new SqlCommand("WAITFOR DELAY '0:0:5';" +
                        "SELECT ProductID, Name, ListPrice, Weight FROM Production.Product",
                        connection);
                    connection.Open();

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the
                    // SqlCommand object as the second parameter in the
                    // BeginExecuteReader call, doing so makes it easier
                    // to call EndExecuteReader in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteReader(callback, command,
                        CommandBehavior.CloseConnection);
                }
                catch (Exception ex)
                {
                    DisplayStatus("Error: " + ex.Message);
                    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 FormClosingEventHandler(Form1_FormClosing);
        }

        void Form1_FormClosing(object sender, FormClosingEventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this, "Cannot close the form until " +
                    "the pending asynchronous command has completed. Please wait...");
                e.Cancel = true;
            }
        }
    }
}
Imports System.Data.SqlClient

Public Class Form1
    ' Add this code to the form's class:
    ' You this delegate in order to fill the grid from
    ' a thread other than the form's thread. See the HandleCallback
    ' procedure for more information.
    Private Delegate Sub FillGridDelegate(ByVal reader As SqlDataReader)

    ' You need this delegate to update the status bar.
    Private Delegate Sub DisplayStatusDelegate(ByVal Text As String)

    ' This flag ensures that the user does not attempt
    ' to restart the command or close the form while the 
    ' asynchronous command is executing.
    Private isExecuting As Boolean

    Private Sub DisplayStatus(ByVal Text As String)
        Me.Label1.Text = Text
    End Sub

    Private Sub FillGrid(ByVal reader As SqlDataReader)
        Try
            Dim table As New DataTable
            table.Load(reader)
            Me.DataGridView1.DataSource = table
            DisplayStatus("Ready")

        Catch ex As Exception
            ' Because you are guaranteed this procedure
            ' is running from within the form's thread,
            ' it can directly interact with members of the form.
            DisplayStatus(String.Format("Ready (last attempt failed: {0})", ex.Message))
        Finally
            ' Closing the reader also closes the connection,
            ' because this reader was created using the 
            ' CommandBehavior.CloseConnection value.
            If reader IsNot Nothing Then
                reader.Close()
            End If
        End Try
    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 SqlDataReader = command.EndExecuteReader(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. Therefore you cannot simply call code that 
            ' fills the grid, like this:
            ' FillGrid(reader)

            ' 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 FillGridDelegate(AddressOf FillGrid)
            Me.Invoke(del, reader)

            ' Do not close the reader here, because it is being used in 
            ' a separate thread. Instead, have the procedure you have
            ' called close the reader once it is done with it.

        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 there is none of 
            ' your code 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 DisplayStatusDelegate(AddressOf DisplayStatus), _
             "Error: " & ex.Message)
        Finally
            isExecuting = False
        End Try
    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 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"
    End Function

    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 connection As SqlConnection
            Dim command As SqlCommand
            Try
                DisplayStatus("Connecting...")
                connection = New SqlConnection(GetConnectionString())
                ' To emulate a long-running query, wait for 
                ' a few seconds before retrieving the real data.
                command = New SqlCommand( _
                 "WAITFOR DELAY '0:0:5';" & _
                 "SELECT ProductID, Name, ListPrice, Weight FROM Production.Product", _
                 connection)
                connection.Open()

                DisplayStatus("Executing...")
                isExecuting = True
                ' Although it is not required that you pass the 
                ' SqlCommand object as the second parameter in the 
                ' BeginExecuteReader call, doing so makes it easier
                ' to call EndExecuteReader in the callback procedure.
                Dim callback As New AsyncCallback(AddressOf HandleCallback)
                command.BeginExecuteReader(callback, command, _
                  CommandBehavior.CloseConnection)

            Catch ex As Exception
                DisplayStatus("Error: " & ex.Message)
                If connection IsNot Nothing Then
                    connection.Close()
                End If
            End Try
        End If
    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
End Class

Açıklamalar

yöntemi, BeginExecuteReader deyimi yürütülürken diğer görevlerin eşzamanlı olarak çalışabilmesi için satır 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 EndExecuteReader işlemi tamamlamak ve komutu tarafından döndürüleni SqlDataReader almak için yöntemini çağırması gerekir. BeginExecuteReader yöntemi hemen döndürür, ancak kod karşılık gelen EndExecuteReader 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 EndExecuteReader çağırmak, yürütme tamamlanana kadar nesnesinin engellenmesine neden olur SqlCommand .

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 EndExecuteReader . Ayrıca parametresindeki stateObject herhangi bir nesneyi geçirebilirsiniz ve geri çağırma yordamınız özelliğini kullanarak AsyncState bu bilgileri alabilir.

parametresi, behavior komutun davranışını ve bağlantısını denetleyebilen seçenekleri belirtmenize olanak tanır. Bu değerler birlikte birleştirilebilir (programlama dilinin Or işleci kullanılarak); genellikle geliştiriciler, kapatıldığında SqlDataReader bağlantının çalışma zamanı tarafından kapatıldığından emin olmak için değerini kullanırCloseConnection. Geliştiriciler ayrıca Transact-SQL deyiminin veya saklı yordamın SqlDataReaderSingleRow yalnızca tek bir satır döndürdüğü önceden bilindiğinde değerini belirterek davranışını iyileştirebilir.

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, daha fazla veri gerektiğinde ve Read temel alınan ağın okuma işlemi engelleniyorsa çağrısının engel olabileceği anlamına gelir.

Geri çağırma yordamı Microsoft .NET ortak dil çalışma zamanı tarafından sağlanan bir arka plan iş parçacığı içinden yürütülür, çünkü uygulamalarınızdan çapraz iş parçacığı etkileşimlerini işlemek için sıkı bir yaklaşım benimsemeniz çok önemlidir. Örneğin, geri çağırma yordamınızın içinden formun içeriğiyle etkileşim kurmamalısınız; formu güncelleştirmeniz gerekiyorsa, işinizi yapmak için formun iş parçacığına geri dönmeniz gerekir. Bu konudaki örnekte bu davranış gösterilmektedir.

İş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 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 .

Ayrıca bkz.

Şunlara uygulanır