SqlCommand.BeginExecuteReader Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Inicializuje asynchronní provádění transact-SQL příkaz nebo uložená procedura, která je popsána tímto SqlCommanda načte jednu nebo více sad výsledků ze serveru.
Přetížení
| BeginExecuteReader() |
Zahájí asynchronní spuštění příkazu Jazyka Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommanda načte jednu nebo více sad výsledků ze serveru. |
| BeginExecuteReader(CommandBehavior) |
Zahájí asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána pomocí SqlCommand jedné z CommandBehavior hodnot. |
| BeginExecuteReader(AsyncCallback, Object) |
Zahájí asynchronní spuštění příkazu Jazyka Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommand a načte jednu nebo více sad výsledků ze serveru, vzhledem k postupu zpětného volání a informace o stavu. |
| BeginExecuteReader(AsyncCallback, Object, CommandBehavior) |
Zahájí asynchronní spuštění příkazu Jazyka Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommandpříkazem , pomocí jedné z |
BeginExecuteReader()
Zahájí asynchronní spuštění příkazu Jazyka Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommanda načte jednu nebo více sad výsledků ze serveru.
public:
IAsyncResult ^ BeginExecuteReader();public IAsyncResult BeginExecuteReader ();member this.BeginExecuteReader : unit -> IAsyncResultPublic Function BeginExecuteReader () As IAsyncResultNávraty
Objekt IAsyncResult , který lze použít k dotazování nebo čekání na výsledky, nebo obojí. Tato hodnota je také nutná při vyvolání EndExecuteReader(IAsyncResult), která vrátí SqlDataReader instanci, která se dá použít k načtení vrácených řádků.
Výjimky
Při SqlDbType nastavení na Streamhodnotu byla použita Value jiná hodnota než Binary nebo VarBinary. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
-nebo-
Při SqlDbType nastavení na TextReaderhodnotu se použila Value jiná hodnota než Char, NChar, NVarChar, VarChar nebo XML.
-nebo-
Při SqlDbType nastavení na XmlReaderhodnotu byla použita Value jiná hodnota než XML.
Jakákoli chyba, ke které došlo při provádění textu příkazu.
-nebo-
Během operace streamování došlo k vypršení časového limitu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Dvojice název/hodnota Asynchronní zpracování=true nebyla zahrnuta do připojovací řetězec definující připojení pro tento SqlCommandobjekt .
-nebo-
Zavřený SqlConnection nebo vynechaný během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Během operace streamování došlo v objektu Streamnebo TextReaderXmlReader k chybě. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Objekt Streamnebo XmlReaderTextReader byl uzavřen během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Příklady
Následující konzolová aplikace spustí proces asynchronního načítání čtečky dat. Při čekání na výsledky se tato jednoduchá aplikace nachází ve smyčce a zkoumá IsCompleted hodnotu vlastnosti. Jakmile se proces dokončí, kód načte SqlDataReader a zobrazí jeho obsah.
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
Poznámky
Metoda BeginExecuteReader spustí proces asynchronního spuštění příkazu Jazyka Transact-SQL nebo uložené procedury, která vrací řádky, aby ostatní úlohy mohly běžet souběžně během provádění příkazu. Po dokončení příkazu musí vývojáři zavolat metodu EndExecuteReader dokončit operaci a načíst vrácenou SqlDataReader příkazem. Metoda BeginExecuteReader vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteReader volání metody, nesmí spouštět žádná další volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteReader Volání příkazu před dokončením provádění příkazu způsobí blokování objektuSqlCommand, dokud se provádění nedokončí.
Všimněte si, že text a parametry příkazu se na server odesílají synchronně. Pokud je odeslán velký příkaz nebo mnoho parametrů, může tato metoda blokovat během zápisu. Po odeslání příkazu vrátí metoda okamžitě, aniž by čekala na odpověď ze serveru – to znamená, že čtení jsou asynchronní. I když je provádění příkazů asynchronní, načítání hodnot je stále synchronní. To znamená, že volání Read můžou blokovat, pokud je vyžadováno více dat a operace čtení v podkladové síti blokuje.
Vzhledem k tomu, že toto přetížení nepodporuje proceduru zpětného volání, musí se vývojáři dotazovat, zda se příkaz dokončil pomocí IsCompleted vlastnosti IAsyncResult vrácené metodou BeginExecuteReader , nebo počkat na dokončení jednoho nebo více příkazů pomocí AsyncWaitHandle vlastnosti vráceného IAsyncResultpříkazu .
Pokud používáte ExecuteReader data XML nebo BeginExecuteReader k datům XML, vrátí SQL Server všechny výsledky XML delší než 2 033 znaků ve více řádcích po 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader nebo BeginExecuteXmlReader ke čtení dotazů FOR XML.
Tato metoda ignoruje CommandTimeout vlastnost.
Viz také
- Připojení a načítání dat v ADO.NET
- Použití zprostředkovatele dat rozhraní .NET Framework pro SQL Server
- Přehled ADO.NET
Platí pro
BeginExecuteReader(CommandBehavior)
Zahájí asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána pomocí SqlCommand jedné z CommandBehavior hodnot.
public:
IAsyncResult ^ BeginExecuteReader(System::Data::CommandBehavior behavior);public IAsyncResult BeginExecuteReader (System.Data.CommandBehavior behavior);member this.BeginExecuteReader : System.Data.CommandBehavior -> IAsyncResultPublic Function BeginExecuteReader (behavior As CommandBehavior) As IAsyncResultParametry
- behavior
- CommandBehavior
Jedna z CommandBehavior hodnot označující možnosti pro spuštění příkazů a načtení dat.
Návraty
Objekt IAsyncResult , který lze použít k dotazování, čekání na výsledky nebo obojí. Tato hodnota je také nutná při vyvolání EndExecuteReader(IAsyncResult), která vrátí SqlDataReader instanci, která se dá použít k načtení vrácených řádků.
Výjimky
Při SqlDbType nastavení na Streamhodnotu byla použita Value jiná hodnota než Binary nebo VarBinary. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
-nebo-
Při SqlDbType nastavení na TextReaderhodnotu se použila Value jiná hodnota než Char, NChar, NVarChar, VarChar nebo XML.
-nebo-
Při SqlDbType nastavení na XmlReaderhodnotu byla použita Value jiná hodnota než XML.
Jakákoli chyba, ke které došlo při provádění textu příkazu.
-nebo-
Během operace streamování došlo k vypršení časového limitu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Dvojice název/hodnota Asynchronní zpracování=true nebyla zahrnuta do připojovací řetězec definující připojení pro tento SqlCommandobjekt .
-nebo-
Zavřený SqlConnection nebo vynechaný během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Během operace streamování došlo v objektu Streamnebo TextReaderXmlReader k chybě. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Objekt Streamnebo XmlReaderTextReader byl uzavřen během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Příklady
Následující konzolová aplikace spustí proces asynchronního načítání čtečky dat. Při čekání na výsledky se tato jednoduchá aplikace nachází ve smyčce a zkoumá IsCompleted hodnotu vlastnosti. Po dokončení procesu kód načte SqlDataReader a zobrazí jeho obsah.
Tento příklad také předá CommandBehavior.CloseConnection hodnoty a CommandBehavior.SingleRow v parametru chování, což způsobí, že připojení bude uzavřeno s vráceným SqlDataReader je uzavřeno a optimalizuje se pro výsledek s jedním řádkem.
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
Poznámky
Metoda BeginExecuteReader spustí proces asynchronního spuštění příkazu Jazyka Transact-SQL nebo uložené procedury, která vrací řádky, aby ostatní úlohy mohly běžet souběžně během provádění příkazu. Po dokončení příkazu musí vývojáři zavolat metodu EndExecuteReader dokončit operaci a načíst vrácenou SqlDataReader příkazem. Metoda BeginExecuteReader vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteReader volání metody, nesmí spouštět žádná další volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteReader Volání příkazu před dokončením provádění příkazu způsobí blokování objektuSqlCommand, dokud se provádění nedokončí.
Parametr behavior umožňuje zadat možnosti, které řídí chování příkazu a jeho připojení. Tyto hodnoty lze zkombinovat dohromady (pomocí operátoru programovacího jazyka OR ); obecně platí, že vývojáři používají CommandBehavior.CloseConnection hodnotu, aby zajistili, že je připojení uzavřeno modulem runtime při SqlDataReader zavření.
Všimněte si, že text a parametry příkazu se na server odesílají synchronně. Pokud je odeslán velký příkaz nebo mnoho parametrů, může tato metoda blokovat během zápisu. Po odeslání příkazu vrátí metoda okamžitě, aniž by čekala na odpověď ze serveru – to znamená, že čtení jsou asynchronní. I když je provádění příkazů asynchronní, načítání hodnot je stále synchronní. To znamená, že volání Read můžou blokovat, pokud je vyžadováno více dat a operace čtení v podkladové síti blokuje.
Vzhledem k tomu, že toto přetížení nepodporuje proceduru zpětného volání, musí se vývojáři dotazovat, zda se příkaz dokončil pomocí IsCompleted vlastnosti IAsyncResult vrácené metodou BeginExecuteNonQuery , nebo počkat na dokončení jednoho nebo více příkazů pomocí AsyncWaitHandle vlastnosti vráceného IAsyncResultpříkazu .
Pokud používáte ExecuteReader nebo BeginExecuteReader pro přístup k datům XML, vrátí SQL Server všechny výsledky XML delší než 2 033 znaků ve více řádcích po 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader nebo BeginExecuteXmlReader ke čtení dotazů FOR XML.
Tato metoda ignoruje CommandTimeout vlastnost.
Viz také
- Připojení a načítání dat v ADO.NET
- Použití zprostředkovatele dat rozhraní .NET Framework pro SQL Server
- Přehled ADO.NET
Platí pro
BeginExecuteReader(AsyncCallback, Object)
Zahájí asynchronní spuštění příkazu Jazyka Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommand a načte jednu nebo více sad výsledků ze serveru, vzhledem k postupu zpětného volání a informace o stavu.
public:
IAsyncResult ^ BeginExecuteReader(AsyncCallback ^ callback, System::Object ^ stateObject);public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject);member this.BeginExecuteReader : AsyncCallback * obj -> IAsyncResultPublic Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object) As IAsyncResultParametry
- callback
- AsyncCallback
Delegát AsyncCallback , který je vyvolán po dokončení provádění příkazu. Předat null (Nothing v Microsoft Visual Basicu) značí, že se nevyžaduje žádné zpětné volání.
- stateObject
- Object
Objekt stavu definovaný uživatelem, který je předán do procedury zpětného volání. Načtěte tento objekt z procedury zpětného volání pomocí AsyncState vlastnosti .
Návraty
Slouží IAsyncResult k dotazování, čekání na výsledky nebo obojí. Tato hodnota je také nutná při vyvolání EndExecuteReader(IAsyncResult), která vrátí SqlDataReader instanci, která se dá použít k načtení vrácených řádků.
Výjimky
Při SqlDbType nastavení na Streamhodnotu byla použita Value jiná hodnota než Binary nebo VarBinary. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
-nebo-
Při SqlDbType nastavení na TextReaderhodnotu se použila Value jiná hodnota než Char, NChar, NVarChar, VarChar nebo XML.
-nebo-
Při SqlDbType nastavení na XmlReaderhodnotu byla použita Value jiná hodnota než XML.
Jakákoli chyba, ke které došlo při provádění textu příkazu.
-nebo-
Během operace streamování došlo k vypršení časového limitu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Dvojice název/hodnota Asynchronní zpracování=true nebyla zahrnuta do připojovací řetězec definující připojení pro tento SqlCommandobjekt .
-nebo-
Zavřený SqlConnection nebo vynechaný během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Během operace streamování došlo v objektu Streamnebo TextReaderXmlReader k chybě. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Objekt Streamnebo XmlReaderTextReader byl uzavřen během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Příklady
Následující aplikace systému Windows demonstruje použití BeginExecuteReader metody spuštění příkazu Jazyka Transact-SQL, který obsahuje zpoždění o několik sekund (emuluje dlouhotrvající příkaz). Vzhledem k tomu, že ukázka spouští příkaz asynchronně, zůstane formulář při čekání na výsledky responzivní. Tento příklad předá exekuující SqlCommand objekt jako stateObject parametr, což usnadňuje načtení objektu SqlCommand z procedury zpětného volání, aby kód mohl volat metodu EndExecuteReader odpovídající počátečnímu BeginExecuteReadervolání .
Tento příklad ukazuje mnoho důležitých technik. To zahrnuje volání metody, která interaguje s formulářem ze samostatného vlákna. Kromě toho tento příklad ukazuje, jak musíte uživatelům zablokovat provádění příkazu vícekrát současně a jak se musíte ujistit, že se formulář před voláním procedury zpětného volání nezavře.
Pokud chcete nastavit tento příklad, vytvořte novou aplikaci pro Windows. Button Do formuláře vložte ovládací prvek, DataGridView ovládací prvek a Label ovládací prvek (přijměte výchozí název každého ovládacího prvku). Do třídy formuláře přidejte následující kód a upravte připojovací řetězec podle potřeby pro vaše prostředí.
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
Poznámky
Metoda BeginExecuteReader spustí proces asynchronního spuštění příkazu Jazyka Transact-SQL nebo uložené procedury, která vrací řádky, aby ostatní úlohy mohly běžet souběžně během provádění příkazu. Po dokončení příkazu musí vývojáři zavolat metodu EndExecuteReader dokončit operaci a načíst vrácenou SqlDataReader příkazem. Metoda BeginExecuteReader vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteReader volání metody, nesmí spouštět žádná další volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteReader Volání příkazu před dokončením provádění příkazu způsobí blokování objektuSqlCommand, dokud se provádění nedokončí.
Parametr callback umožňuje určit delegáta AsyncCallback , který je volána po dokončení příkazu. Metodu EndExecuteReader můžete volat z této procedury delegáta nebo z libovolného jiného umístění ve vaší aplikaci. Kromě toho můžete předat libovolný objekt v parametru stateObject a procedura zpětného volání může tyto informace načíst pomocí AsyncState vlastnosti .
Všimněte si, že text a parametry příkazu se na server odesílají synchronně. Pokud je odeslán velký příkaz nebo mnoho parametrů, může tato metoda blokovat během zápisu. Po odeslání příkazu vrátí metoda okamžitě, aniž by čekala na odpověď ze serveru – to znamená, že čtení jsou asynchronní. I když je provádění příkazů asynchronní, načítání hodnot je stále synchronní. To znamená, že volání Read můžou blokovat, pokud je vyžadováno více dat a operace čtení v podkladové síti blokuje.
Vzhledem k tomu, že se procedura zpětného volání spouští z vlákna na pozadí poskytovaného modulem runtime Microsoft .NET, je velmi důležité, abyste při zpracování interakcí mezi vlákny v rámci vašich aplikací podnikli přísný přístup. Například nesmíte interagovat s obsahem formuláře v rámci procedury zpětného volání; Pokud budete muset formulář aktualizovat, musíte přepnout zpět na vlákno formuláře, abyste mohli pracovat. Příklad v tomto tématu ukazuje toto chování.
Všechny chyby, ke kterým dochází během provádění operace, jsou vyvolány jako výjimky v proceduře zpětného volání. Výjimku musíte zpracovat v proceduře zpětného volání, nikoli v hlavní aplikaci. Další informace o zpracování výjimek v proceduře zpětného volání najdete v příkladu v tomto tématu.
Pokud používáte ExecuteReader nebo BeginExecuteReader pro přístup k datům XML, vrátí SQL Server všechny výsledky XML delší než 2 033 znaků ve více řádcích po 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader nebo BeginExecuteXmlReader ke čtení dotazů FOR XML.
Tato metoda ignoruje CommandTimeout vlastnost.
Viz také
- Připojení a načítání dat v ADO.NET
- Použití zprostředkovatele dat rozhraní .NET Framework pro SQL Server
- Přehled ADO.NET
Platí pro
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)
Inicializuje asynchronní spuštění transact-SQL příkaz nebo uložená procedura, která je popsána v tomto SqlCommand, pomocí jedné z CommandBehavior hodnot a načtení jedné nebo více sad výsledků ze serveru, vzhledem k postupu zpětného volání a informací o stavu.
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 -> IAsyncResultPublic Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object, behavior As CommandBehavior) As IAsyncResultParametry
- callback
- AsyncCallback
Delegát AsyncCallback , který je vyvolán po dokončení provádění příkazu. Předat null (Nothing v Microsoft Visual Basicu) značí, že se nevyžaduje žádné zpětné volání.
- stateObject
- Object
Objekt stavu definovaný uživatelem, který je předán do procedury zpětného volání. Načtěte tento objekt z procedury zpětného volání pomocí AsyncState vlastnosti .
- behavior
- CommandBehavior
Jedna z CommandBehavior hodnot označující možnosti pro spuštění příkazů a načtení dat.
Návraty
Hodnota IAsyncResult , která se dá použít k dotazování nebo čekání na výsledky, nebo obojí; tato hodnota je také potřeba při vyvolání EndExecuteReader(IAsyncResult), která vrací SqlDataReader instanci, která se dá použít k načtení vrácených řádků.
Výjimky
Při SqlDbType nastavení na Streamhodnotu byla použita Value jiná hodnota než Binary nebo VarBinary. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
-nebo-
Při SqlDbType nastavení na TextReaderhodnotu se použila Value jiná hodnota než Char, NChar, NVarChar, VarChar nebo XML.
-nebo-
Při SqlDbType nastavení na XmlReaderhodnotu byla použita Value jiná hodnota než XML.
Jakákoli chyba, ke které došlo při provádění textu příkazu.
-nebo-
Během operace streamování došlo k vypršení časového limitu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Dvojice název/hodnota Asynchronní zpracování=true nebyla zahrnuta do připojovací řetězec definující připojení pro tento SqlCommandobjekt .
-nebo-
Zavřený SqlConnection nebo vynechaný během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Během operace streamování došlo v objektu Streamnebo TextReaderXmlReader k chybě. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Objekt Streamnebo XmlReaderTextReader byl uzavřen během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Příklady
Následující aplikace systému Windows demonstruje použití BeginExecuteReader metody spuštění příkazu Jazyka Transact-SQL, který obsahuje zpoždění o několik sekund (emuluje dlouhotrvající příkaz). Vzhledem k tomu, že ukázka spouští příkaz asynchronně, zůstane formulář při čekání na výsledky responzivní. Tento příklad předá exekuující SqlCommand objekt jako stateObject parametr, což usnadňuje načtení objektu SqlCommand z procedury zpětného volání, aby kód mohl volat metodu EndExecuteReader odpovídající počátečnímu BeginExecuteReadervolání .
Tento příklad ukazuje mnoho důležitých technik. To zahrnuje volání metody, která interaguje s formulářem ze samostatného vlákna. Kromě toho tento příklad ukazuje, jak musíte uživatelům zablokovat provádění příkazu vícekrát současně a jak se musíte ujistit, že se formulář před voláním procedury zpětného volání nezavře.
Pokud chcete nastavit tento příklad, vytvořte novou aplikaci pro Windows. Button Do formuláře vložte ovládací prvek, DataGridView ovládací prvek a Label ovládací prvek (přijměte výchozí název každého ovládacího prvku). Do třídy formuláře přidejte následující kód a upravte připojovací řetězec podle potřeby pro vaše prostředí.
Tento příklad předá CommandBehavior.CloseConnection hodnotu v parametru behavior , což způsobí, že vrácený SqlDataReader objekt automaticky ukončí své připojení při jeho zavření.
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
Poznámky
Metoda BeginExecuteReader spustí proces asynchronního spuštění příkazu Jazyka Transact-SQL nebo uložené procedury, která vrací řádky, aby ostatní úlohy mohly běžet souběžně během provádění příkazu. Po dokončení příkazu musí vývojáři zavolat metodu EndExecuteReader dokončit operaci a načíst vrácenou SqlDataReader příkazem. Metoda BeginExecuteReader vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteReader volání metody, nesmí spouštět žádná další volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteReader Volání příkazu před dokončením provádění příkazu způsobí blokování objektuSqlCommand, dokud se provádění nedokončí.
Parametr callback umožňuje určit delegáta AsyncCallback , který je volána po dokončení příkazu. Metodu EndExecuteReader můžete volat z této procedury delegáta nebo z libovolného jiného umístění ve vaší aplikaci. Kromě toho můžete předat libovolný objekt v parametru stateObject a procedura zpětného volání může tyto informace načíst pomocí AsyncState vlastnosti .
Parametr behavior umožňuje zadat možnosti, které řídí chování příkazu a jeho připojení. Tyto hodnoty lze zkombinovat dohromady (pomocí operátoru programovacího jazyka Or ); obecně platí, že vývojáři používají CloseConnection hodnotu, aby zajistili, že je připojení uzavřeno modulem runtime při SqlDataReader zavření. Vývojáři mohou také optimalizovat chování objektu SqlDataReader zadáním SingleRow hodnoty, pokud je předem známo, že příkaz Jazyka Transact-SQL nebo uložená procedura vrací pouze jeden řádek.
Všimněte si, že text a parametry příkazu se na server odesílají synchronně. Pokud je odeslán velký příkaz nebo mnoho parametrů, může tato metoda blokovat během zápisu. Po odeslání příkazu vrátí metoda okamžitě, aniž by čekala na odpověď ze serveru – to znamená, že čtení jsou asynchronní. I když je provádění příkazů asynchronní, načítání hodnot je stále synchronní. To znamená, že volání Read můžou blokovat, pokud je vyžadováno více dat a operace čtení v podkladové síti blokuje.
Vzhledem k tomu, že se procedura zpětného volání spouští z vlákna na pozadí poskytovaného modulem ClR (Common Language Runtime) Microsoft .NET, je velmi důležité, abyste ke zpracování interakcí mezi vlákny v rámci vašich aplikací přistupovali přísným způsobem. Například nesmíte interagovat s obsahem formuláře v rámci postupu zpětného volání – pokud budete muset formulář aktualizovat, musíte přepnout zpět na vlákno formuláře, abyste mohli pracovat. Příklad v tomto tématu ukazuje toto chování.
Všechny chyby, ke kterým dojde během provádění operace, jsou vyvolán jako výjimky v proceduře zpětného volání. Výjimku musíte zpracovat v proceduře zpětného volání, nikoli v hlavní aplikaci. Další informace o zpracování výjimek v proceduře zpětného volání najdete v příkladu v tomto tématu.
Pokud používáte ExecuteReader nebo BeginExecuteReader pro přístup k datům XML, vrátí SQL Server všechny výsledky XML delší než 2 033 znaků ve více řádcích po 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader nebo BeginExecuteXmlReader ke čtení dotazů FOR XML.
Tato metoda ignoruje CommandTimeout vlastnost .
Viz také
- Připojení a načítání dat v ADO.NET
- Použití zprostředkovatele dat rozhraní .NET Framework pro SQL Server
- Přehled ADO.NET
