SqlCommand.BeginExecuteReader Methode
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Start de asynchrone uitvoering van de Transact-SQL-instructie of opgeslagen procedure die wordt beschreven door deze SqlCommand en haalt een of meer resultatensets op van de server.
Overloads
| Name | Description |
|---|---|
| BeginExecuteReader() |
Start de asynchrone uitvoering van de Transact-SQL-instructie of opgeslagen procedure die wordt beschreven door deze SqlCommand en haalt een of meer resultatensets op van de server. |
| BeginExecuteReader(CommandBehavior) |
Start de asynchrone uitvoering van de Transact-SQL instructie of opgeslagen procedure die wordt beschreven door deze SqlCommand met behulp van een van de CommandBehavior waarden. |
| BeginExecuteReader(AsyncCallback, Object) |
Start de asynchrone uitvoering van de Transact-SQL instructie of opgeslagen procedure die wordt beschreven door deze SqlCommand en haalt een of meer resultatensets op van de server, op basis van een callback-procedure en statusinformatie. |
| BeginExecuteReader(AsyncCallback, Object, CommandBehavior) |
Start de asynchrone uitvoering van de Transact-SQL instructie of opgeslagen procedure die wordt beschreven door deze SqlCommand, met behulp van een van de |
BeginExecuteReader()
Start de asynchrone uitvoering van de Transact-SQL-instructie of opgeslagen procedure die wordt beschreven door deze SqlCommand en haalt een of meer resultatensets op van de server.
public:
IAsyncResult ^ BeginExecuteReader();
public IAsyncResult BeginExecuteReader();
member this.BeginExecuteReader : unit -> IAsyncResult
Public Function BeginExecuteReader () As IAsyncResult
Retouren
Een IAsyncResult die kan worden gebruikt om resultaten te peilen of te wachten, of beide; deze waarde is ook nodig bij het aanroepen EndExecuteReader(IAsyncResult), dat een SqlDataReader exemplaar retourneert dat kan worden gebruikt om de geretourneerde rijen op te halen.
Uitzonderingen
Een SqlDbType andere dan Binary of VarBinary is gebruikt wanneer Value deze is ingesteld op Stream. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
– of –
Een SqlDbType andere naam dan Char, NChar, NVarChar, VarChar of XML is gebruikt wanneer Value deze is ingesteld op TextReader.
– of –
Er is een SqlDbType andere dan XML gebruikt wanneer Value deze is ingesteld op XmlReader.
Eventuele fouten die zijn opgetreden tijdens het uitvoeren van de opdrachttekst.
– of –
Er is een time-out opgetreden tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Het naam-/waardepaar 'Asynchrone verwerking=true' is niet opgenomen in de verbindingsreeks het definiëren van de verbinding voor deze SqlCommand.
– of –
De SqlConnection gesloten of verbroken tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Er is een fout opgetreden in een Streamof XmlReaderTextReader object tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Het Streamobject XmlReader of TextReader het object is gesloten tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Voorbeelden
Met de volgende consoletoepassing wordt het proces voor het ophalen van een gegevenslezer asynchroon gestart. Tijdens het wachten op de resultaten, bevindt deze eenvoudige toepassing zich in een lus, waarbij de IsCompleted eigenschapswaarde wordt onderzocht. Zodra het proces is voltooid, wordt de code opgehaald en wordt de SqlDataReader inhoud ervan weergegeven.
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
Opmerkingen
Met de methode BeginExecuteReader wordt het proces gestart van het asynchroon uitvoeren van een Transact-SQL-instructie of opgeslagen procedure die rijen retourneert, zodat andere taken gelijktijdig kunnen worden uitgevoerd terwijl de instructie wordt uitgevoerd. Wanneer de instructie is voltooid, moeten ontwikkelaars de methode aanroepen om de EndExecuteReader bewerking te voltooien en de SqlDataReader geretourneerde opdracht op te halen. De BeginExecuteReader methode retourneert onmiddellijk, maar totdat de code de bijbehorende EndExecuteReader methodeaanroep uitvoert, mag deze geen andere aanroepen uitvoeren die een synchrone of asynchrone uitvoering starten op hetzelfde SqlCommand object. Als u de uitvoering van de EndExecuteReader opdracht aanroept, wordt het SqlCommand object geblokkeerd totdat de uitvoering is voltooid.
Houd er rekening mee dat de opdrachttekst en -parameters synchroon naar de server worden verzonden. Als een grote opdracht of veel parameters worden verzonden, kan deze methode tijdens schrijfbewerkingen blokkeren. Nadat de opdracht is verzonden, wordt de methode onmiddellijk geretourneerd zonder te wachten op een antwoord van de server. Leesbewerkingen zijn asynchroon. Hoewel de uitvoering van de opdracht asynchroon is, is het ophalen van waarden nog steeds synchroon. Dit betekent dat aanroepen om te Read blokkeren als er meer gegevens nodig zijn en de leesbewerkingsblokken van het onderliggende netwerk.
Omdat deze overbelasting geen callback-procedure ondersteunt, moeten ontwikkelaars pollen om te bepalen of de opdracht is voltooid, met behulp van de IsCompleted eigenschap van de IAsyncResult geretourneerde BeginExecuteReader methode; of wachten totdat een of meer opdrachten zijn voltooid met behulp van de AsyncWaitHandle eigenschap van de geretourneerde IAsyncResult.
Als u ExecuteReader of BeginExecuteReader gebruikt voor toegang tot XML-gegevens, retourneert SQL Server xml-resultaten die langer zijn dan 2033 tekens in meerdere rijen van elk 2033 tekens. Gebruik of BeginExecuteXmlReader lees FOR XML-query's om dit gedrag ExecuteXmlReader te voorkomen.
Met deze methode wordt de CommandTimeout eigenschap genegeerd.
Zie ook
- Verbinding maken en ophalen van gegevens in ADO.NET
- Using the .NET Framework Data Provider for SQL Server
- overzicht van ADO.NET
Van toepassing op
BeginExecuteReader(CommandBehavior)
Start de asynchrone uitvoering van de Transact-SQL instructie of opgeslagen procedure die wordt beschreven door deze SqlCommand met behulp van een van de CommandBehavior waarden.
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
Parameters
- behavior
- CommandBehavior
Een van de CommandBehavior waarden die opties voor het uitvoeren van instructies en het ophalen van gegevens aangeven.
Retouren
Een IAsyncResult die kan worden gebruikt om te peilen, te wachten op resultaten of beide; deze waarde is ook nodig bij het aanroepen EndExecuteReader(IAsyncResult), waarmee een SqlDataReader exemplaar wordt geretourneerd dat kan worden gebruikt om de geretourneerde rijen op te halen.
Uitzonderingen
Een SqlDbType andere dan Binary of VarBinary is gebruikt wanneer Value deze is ingesteld op Stream. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
– of –
Een SqlDbType andere naam dan Char, NChar, NVarChar, VarChar of XML is gebruikt wanneer Value deze is ingesteld op TextReader.
– of –
Er is een SqlDbType andere dan XML gebruikt wanneer Value deze is ingesteld op XmlReader.
Eventuele fouten die zijn opgetreden tijdens het uitvoeren van de opdrachttekst.
– of –
Er is een time-out opgetreden tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Het naam-/waardepaar 'Asynchrone verwerking=true' is niet opgenomen in de verbindingsreeks het definiëren van de verbinding voor deze SqlCommand.
– of –
De SqlConnection gesloten of verbroken tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Er is een fout opgetreden in een Streamof XmlReaderTextReader object tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Het Streamobject XmlReader of TextReader het object is gesloten tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Voorbeelden
Met de volgende consoletoepassing wordt het proces voor het ophalen van een gegevenslezer asynchroon gestart. Tijdens het wachten op de resultaten, bevindt deze eenvoudige toepassing zich in een lus, waarbij de IsCompleted eigenschapswaarde wordt onderzocht. Zodra het proces is voltooid, wordt de code opgehaald en wordt de SqlDataReader inhoud ervan weergegeven.
In dit voorbeeld worden ook de CommandBehavior.CloseConnection waarden in CommandBehavior.SingleRow de gedragsparameter doorgegeven, waardoor de verbinding wordt gesloten met de geretourneerde SqlDataReader is gesloten en om te optimaliseren voor één rijresultaat.
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
Opmerkingen
Met de methode BeginExecuteReader wordt het proces gestart van het asynchroon uitvoeren van een Transact-SQL-instructie of opgeslagen procedure die rijen retourneert, zodat andere taken gelijktijdig kunnen worden uitgevoerd terwijl de instructie wordt uitgevoerd. Wanneer de instructie is voltooid, moeten ontwikkelaars de methode aanroepen om de EndExecuteReader bewerking te voltooien en de SqlDataReader geretourneerde opdracht op te halen. De BeginExecuteReader methode retourneert onmiddellijk, maar totdat de code de bijbehorende EndExecuteReader methodeaanroep uitvoert, mag deze geen andere aanroepen uitvoeren die een synchrone of asynchrone uitvoering starten op hetzelfde SqlCommand object. Als u de uitvoering van de EndExecuteReader opdracht aanroept, wordt het SqlCommand object geblokkeerd totdat de uitvoering is voltooid.
Met behavior de parameter kunt u opties opgeven waarmee het gedrag van de opdracht en de bijbehorende verbinding wordt bepaald. Deze waarden kunnen worden gecombineerd (met behulp van de operator van OR de programmeertaal); over het algemeen gebruiken ontwikkelaars de CommandBehavior.CloseConnection waarde om ervoor te zorgen dat de verbinding door de runtime wordt gesloten wanneer de SqlDataReader computer wordt gesloten.
Houd er rekening mee dat de opdrachttekst en -parameters synchroon naar de server worden verzonden. Als een grote opdracht of veel parameters worden verzonden, kan deze methode tijdens schrijfbewerkingen blokkeren. Nadat de opdracht is verzonden, wordt de methode onmiddellijk geretourneerd zonder te wachten op een antwoord van de server. Leesbewerkingen zijn asynchroon. Hoewel de uitvoering van de opdracht asynchroon is, is het ophalen van waarden nog steeds synchroon. Dit betekent dat aanroepen om te Read blokkeren als er meer gegevens nodig zijn en de leesbewerkingsblokken van het onderliggende netwerk.
Omdat deze overbelasting geen callback-procedure ondersteunt, moeten ontwikkelaars pollen om te bepalen of de opdracht is voltooid, met behulp van de IsCompleted eigenschap van de IAsyncResult geretourneerde BeginExecuteNonQuery methode; of wachten totdat een of meer opdrachten zijn voltooid met behulp van de AsyncWaitHandle eigenschap van de geretourneerde IAsyncResult.
Als u ExecuteReader of BeginExecuteReader gebruikt voor toegang tot XML-gegevens, retourneert SQL Server xml-resultaten die langer zijn dan 2033 tekens in meerdere rijen van elk 2033 tekens. Gebruik of BeginExecuteXmlReader lees FOR XML-query's om dit gedrag ExecuteXmlReader te voorkomen.
Met deze methode wordt de CommandTimeout eigenschap genegeerd.
Zie ook
- Verbinding maken en ophalen van gegevens in ADO.NET
- Using the .NET Framework Data Provider for SQL Server
- overzicht van ADO.NET
Van toepassing op
BeginExecuteReader(AsyncCallback, Object)
Start de asynchrone uitvoering van de Transact-SQL instructie of opgeslagen procedure die wordt beschreven door deze SqlCommand en haalt een of meer resultatensets op van de server, op basis van een callback-procedure en statusinformatie.
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
Parameters
- callback
- AsyncCallback
Een AsyncCallback gemachtigde die wordt aangeroepen wanneer de uitvoering van de opdracht is voltooid. Geef null (Nothing in Microsoft Visual Basic) door om aan te geven dat er geen callback is vereist.
- stateObject
- Object
Een door de gebruiker gedefinieerd statusobject dat wordt doorgegeven aan de callback-procedure. Haal dit object op uit de callback-procedure met behulp van de AsyncState eigenschap.
Retouren
Een IAsyncResult die kan worden gebruikt om te peilen, te wachten op resultaten of beide; deze waarde is ook nodig bij het aanroepen EndExecuteReader(IAsyncResult), waarmee een SqlDataReader exemplaar wordt geretourneerd dat kan worden gebruikt om de geretourneerde rijen op te halen.
Uitzonderingen
Een SqlDbType andere dan Binary of VarBinary is gebruikt wanneer Value deze is ingesteld op Stream. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
– of –
Een SqlDbType andere naam dan Char, NChar, NVarChar, VarChar of XML is gebruikt wanneer Value deze is ingesteld op TextReader.
– of –
Er is een SqlDbType andere dan XML gebruikt wanneer Value deze is ingesteld op XmlReader.
Eventuele fouten die zijn opgetreden tijdens het uitvoeren van de opdrachttekst.
– of –
Er is een time-out opgetreden tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Het naam-/waardepaar 'Asynchrone verwerking=true' is niet opgenomen in de verbindingsreeks het definiëren van de verbinding voor deze SqlCommand.
– of –
De SqlConnection gesloten of verbroken tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Er is een fout opgetreden in een Streamof XmlReaderTextReader object tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Het Streamobject XmlReader of TextReader het object is gesloten tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Voorbeelden
De volgende Windows-toepassing demonstreert het gebruik van de BeginExecuteReader methode, waarbij een Transact-SQL-instructie wordt uitgevoerd die een vertraging van een paar seconden bevat (waarbij een langlopende opdracht wordt geëmuleren). Omdat het voorbeeld de opdracht asynchroon uitvoert, blijft het formulier responsief terwijl de resultaten worden gewacht. In dit voorbeeld wordt het uitvoerende SqlCommand object doorgegeven als de stateObject parameter. Hierdoor is het eenvoudig om het SqlCommand object op te halen vanuit de callback-procedure, zodat de code de EndExecuteReader methode kan aanroepen die overeenkomt met de eerste aanroep naar BeginExecuteReader.
In dit voorbeeld ziet u een groot aantal belangrijke technieken. Dit omvat het aanroepen van een methode die interactie heeft met het formulier vanuit een afzonderlijke thread. Daarnaast laat dit voorbeeld zien hoe u gebruikers moet blokkeren om meerdere keren tegelijk een opdracht uit te voeren en hoe u ervoor moet zorgen dat het formulier niet wordt gesloten voordat de callback-procedure wordt aangeroepen.
Als u dit voorbeeld wilt instellen, maakt u een nieuwe Windows-toepassing. Plaats een Button besturingselement, een DataGridView besturingselement en een Label besturingselement op het formulier (waarbij de standaardnaam voor elk besturingselement wordt geaccepteerd). Voeg de volgende code toe aan de klasse van het formulier en wijzig de verbindingsreeks indien nodig voor uw omgeving.
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
Opmerkingen
Met de methode BeginExecuteReader wordt het proces gestart van het asynchroon uitvoeren van een Transact-SQL-instructie of opgeslagen procedure die rijen retourneert, zodat andere taken gelijktijdig kunnen worden uitgevoerd terwijl de instructie wordt uitgevoerd. Wanneer de instructie is voltooid, moeten ontwikkelaars de methode aanroepen om de EndExecuteReader bewerking te voltooien en de SqlDataReader geretourneerde opdracht op te halen. De BeginExecuteReader methode retourneert onmiddellijk, maar totdat de code de bijbehorende EndExecuteReader methodeaanroep uitvoert, mag deze geen andere aanroepen uitvoeren die een synchrone of asynchrone uitvoering starten op hetzelfde SqlCommand object. Als u de EndExecuteReader opdracht aanroept voordat de uitvoering is voltooid, wordt het SqlCommand object geblokkeerd totdat de uitvoering is voltooid.
callback Met de parameter kunt u een AsyncCallback gemachtigde opgeven die wordt aangeroepen wanneer de instructie is voltooid. U kunt de EndExecuteReader methode aanroepen vanuit deze gedelegeerde procedure of vanaf een andere locatie in uw toepassing. Bovendien kunt u elk object in de stateObject parameter doorgeven en de callback-procedure kan deze informatie ophalen met behulp van de AsyncState eigenschap.
Houd er rekening mee dat de opdrachttekst en -parameters synchroon naar de server worden verzonden. Als een grote opdracht of veel parameters worden verzonden, kan deze methode tijdens schrijfbewerkingen blokkeren. Nadat de opdracht is verzonden, wordt de methode onmiddellijk geretourneerd zonder te wachten op een antwoord van de server. Leesbewerkingen zijn asynchroon. Hoewel de uitvoering van de opdracht asynchroon is, is het ophalen van waarden nog steeds synchroon. Dit betekent dat aanroepen om te Read blokkeren als er meer gegevens nodig zijn en de leesbewerkingsblokken van het onderliggende netwerk.
Omdat de callback-procedure wordt uitgevoerd vanuit een achtergrondthread die wordt geleverd door de Microsoft .NET runtime, is het erg belangrijk dat u een strikte benadering neemt voor het verwerken van crossthreadinteracties vanuit uw toepassingen. U mag bijvoorbeeld niet communiceren met de inhoud van een formulier vanuit uw callbackprocedure; als u het formulier moet bijwerken, moet u teruggaan naar de thread van het formulier om uw werk te kunnen doen. In het voorbeeld in dit onderwerp ziet u dit gedrag.
Alle fouten die optreden tijdens de uitvoering van de bewerking, worden gegenereerd als uitzonderingen in de callback-procedure. U moet de uitzondering in de callback-procedure afhandelen, niet in de hoofdtoepassing. Zie het voorbeeld in dit onderwerp voor meer informatie over het verwerken van uitzonderingen in de callback-procedure.
Als u ExecuteReader of BeginExecuteReader gebruikt voor toegang tot XML-gegevens, retourneert SQL Server xml-resultaten die langer zijn dan 2033 tekens in meerdere rijen van elk 2033 tekens. Gebruik of BeginExecuteXmlReader lees FOR XML-query's om dit gedrag ExecuteXmlReader te voorkomen.
Met deze methode wordt de CommandTimeout eigenschap genegeerd.
Zie ook
- Verbinding maken en ophalen van gegevens in ADO.NET
- Using the .NET Framework Data Provider for SQL Server
- overzicht van ADO.NET
Van toepassing op
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)
Start de asynchrone uitvoering van de Transact-SQL instructie of opgeslagen procedure die wordt beschreven door deze SqlCommand, met behulp van een van de CommandBehavior-waarden en het ophalen van een of meer resultatensets van de server, op basis van een callback-procedure en statusinformatie.
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
Parameters
- callback
- AsyncCallback
Een AsyncCallback gemachtigde die wordt aangeroepen wanneer de uitvoering van de opdracht is voltooid. Geef null (Nothing in Microsoft Visual Basic) door om aan te geven dat er geen callback is vereist.
- stateObject
- Object
Een door de gebruiker gedefinieerd statusobject dat wordt doorgegeven aan de callback-procedure. Haal dit object op uit de callback-procedure met behulp van de AsyncState eigenschap.
- behavior
- CommandBehavior
Een van de CommandBehavior waarden die opties voor het uitvoeren van instructies en het ophalen van gegevens aangeven.
Retouren
Een IAsyncResult die kan worden gebruikt om resultaten te peilen of te wachten, of beide; deze waarde is ook nodig bij het aanroepen EndExecuteReader(IAsyncResult), dat een SqlDataReader exemplaar retourneert dat kan worden gebruikt om de geretourneerde rijen op te halen.
Uitzonderingen
Een SqlDbType andere dan Binary of VarBinary is gebruikt wanneer Value deze is ingesteld op Stream. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
– of –
Een SqlDbType andere naam dan Char, NChar, NVarChar, VarChar of XML is gebruikt wanneer Value deze is ingesteld op TextReader.
– of –
Er is een SqlDbType andere dan XML gebruikt wanneer Value deze is ingesteld op XmlReader.
Eventuele fouten die zijn opgetreden tijdens het uitvoeren van de opdrachttekst.
– of –
Er is een time-out opgetreden tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Het naam-/waardepaar 'Asynchrone verwerking=true' is niet opgenomen in de verbindingsreeks het definiëren van de verbinding voor deze SqlCommand.
– of –
De SqlConnection gesloten of verbroken tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Er is een fout opgetreden in een Streamof XmlReaderTextReader object tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Het Streamobject XmlReader of TextReader het object is gesloten tijdens een streamingbewerking. Zie Ondersteuning voor sqlClient-streaming voor meer informatie over streaming.
Voorbeelden
De volgende Windows-toepassing demonstreert het gebruik van de BeginExecuteReader methode, waarbij een Transact-SQL-instructie wordt uitgevoerd die een vertraging van een paar seconden bevat (waarbij een langlopende opdracht wordt geëmuleren). Omdat het voorbeeld de opdracht asynchroon uitvoert, blijft het formulier responsief terwijl de resultaten worden gewacht. In dit voorbeeld wordt het uitvoerende SqlCommand object doorgegeven als de stateObject parameter. Hierdoor is het eenvoudig om het SqlCommand object op te halen vanuit de callback-procedure, zodat de code de EndExecuteReader methode kan aanroepen die overeenkomt met de eerste aanroep naar BeginExecuteReader.
In dit voorbeeld ziet u een groot aantal belangrijke technieken. Dit omvat het aanroepen van een methode die interactie heeft met het formulier vanuit een afzonderlijke thread. Daarnaast laat dit voorbeeld zien hoe u gebruikers moet blokkeren om meerdere keren tegelijk een opdracht uit te voeren en hoe u ervoor moet zorgen dat het formulier niet wordt gesloten voordat de callback-procedure wordt aangeroepen.
Als u dit voorbeeld wilt instellen, maakt u een nieuwe Windows-toepassing. Plaats een Button besturingselement, een DataGridView besturingselement en een Label besturingselement op het formulier (waarbij de standaardnaam voor elk besturingselement wordt geaccepteerd). Voeg de volgende code toe aan de klasse van het formulier en wijzig de verbindingsreeks indien nodig voor uw omgeving.
In dit voorbeeld wordt de CommandBehavior.CloseConnection waarde in de behavior parameter doorgegeven, waardoor de geretourneerde SqlDataReader verbinding automatisch wordt gesloten wanneer deze wordt gesloten.
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
Opmerkingen
Met de methode BeginExecuteReader wordt het proces gestart van het asynchroon uitvoeren van een Transact-SQL-instructie of opgeslagen procedure die rijen retourneert, zodat andere taken gelijktijdig kunnen worden uitgevoerd terwijl de instructie wordt uitgevoerd. Wanneer de instructie is voltooid, moeten ontwikkelaars de methode aanroepen om de EndExecuteReader bewerking te voltooien en de SqlDataReader geretourneerde opdracht op te halen. De BeginExecuteReader methode retourneert onmiddellijk, maar totdat de code de bijbehorende EndExecuteReader methodeaanroep uitvoert, mag deze geen andere aanroepen uitvoeren die een synchrone of asynchrone uitvoering starten op hetzelfde SqlCommand object. Als u de uitvoering van de EndExecuteReader opdracht aanroept, wordt het SqlCommand object geblokkeerd totdat de uitvoering is voltooid.
callback Met de parameter kunt u een AsyncCallback gemachtigde opgeven die wordt aangeroepen wanneer de instructie is voltooid. U kunt de EndExecuteReader methode aanroepen vanuit deze gedelegeerde procedure of vanaf een andere locatie in uw toepassing. Bovendien kunt u elk object in de stateObject parameter doorgeven en de callback-procedure kan deze informatie ophalen met behulp van de AsyncState eigenschap.
Met behavior de parameter kunt u opties opgeven waarmee het gedrag van de opdracht en de bijbehorende verbinding wordt bepaald. Deze waarden kunnen worden gecombineerd (met behulp van de operator van Or de programmeertaal); over het algemeen gebruiken ontwikkelaars de CloseConnection waarde om ervoor te zorgen dat de verbinding door de runtime wordt gesloten wanneer de SqlDataReader computer wordt gesloten. Ontwikkelaars kunnen ook het gedrag van de SqlDataReader optimaliseren door de waarde SingleRow op te geven wanneer vooraf bekend is dat de Transact-SQL instructie of opgeslagen procedure slechts één rij retourneert.
Houd er rekening mee dat de opdrachttekst en -parameters synchroon naar de server worden verzonden. Als een grote opdracht of veel parameters worden verzonden, kan deze methode tijdens schrijfbewerkingen blokkeren. Nadat de opdracht is verzonden, wordt de methode onmiddellijk geretourneerd zonder te wachten op een antwoord van de server. Leesbewerkingen zijn asynchroon. Hoewel de uitvoering van de opdracht asynchroon is, is het ophalen van waarden nog steeds synchroon. Dit betekent dat aanroepen om te Read blokkeren als er meer gegevens nodig zijn en de leesbewerkingsblokken van het onderliggende netwerk.
Omdat de callback-procedure wordt uitgevoerd vanuit een achtergrondthread die wordt geleverd door de Microsoft .NET algemene taalruntime, is het erg belangrijk dat u een strikte benadering neemt voor het afhandelen van crossthreadinteracties vanuit uw toepassingen. U moet bijvoorbeeld niet communiceren met de inhoud van een formulier vanuit uw callback-procedure. Als u het formulier moet bijwerken, moet u teruggaan naar de thread van het formulier om uw werk te kunnen doen. In het voorbeeld in dit onderwerp ziet u dit gedrag.
Alle fouten die optreden tijdens de uitvoering van de bewerking, worden gegenereerd als uitzonderingen in de callback-procedure. U moet de uitzondering in de callback-procedure afhandelen, niet in de hoofdtoepassing. Zie het voorbeeld in dit onderwerp voor meer informatie over het verwerken van uitzonderingen in de callback-procedure.
Als u ExecuteReader of BeginExecuteReader gebruikt voor toegang tot XML-gegevens, retourneert SQL Server xml-resultaten die langer zijn dan 2033 tekens in meerdere rijen van elk 2033 tekens. Gebruik of BeginExecuteXmlReader lees FOR XML-query's om dit gedrag ExecuteXmlReader te voorkomen.
Met deze methode wordt de CommandTimeout eigenschap genegeerd.
Zie ook
- Verbinding maken en ophalen van gegevens in ADO.NET
- Using the .NET Framework Data Provider for SQL Server
- overzicht van ADO.NET