BackgroundWorker.DoWork Ereignis

Definition

Tritt ein, wenn RunWorkerAsync() aufgerufen wird.Occurs when RunWorkerAsync() is called.

public:
 event System::ComponentModel::DoWorkEventHandler ^ DoWork;
public event System.ComponentModel.DoWorkEventHandler DoWork;
member this.DoWork : System.ComponentModel.DoWorkEventHandler 
Public Custom Event DoWork As DoWorkEventHandler 

Beispiele

Im folgenden Codebeispiel wird die Verwendung des DoWork-Ereignisses zum Starten eines asynchronen Vorgangs veranschaulicht.The following code example demonstrates the use of the DoWork event to start an asynchronous operation. Dieses Codebeispiel ist Teil eines größeren Beispiels, das für die BackgroundWorker-Klasse bereitgestellt wird.This code example is part of a larger example provided for the BackgroundWorker class.

// This event handler is where the actual,
// potentially time-consuming work is done.
void backgroundWorker1_DoWork( Object^ sender, DoWorkEventArgs^ e )
{
   // Get the BackgroundWorker that raised this event.
   BackgroundWorker^ worker = dynamic_cast<BackgroundWorker^>(sender);

   // Assign the result of the computation
   // to the Result property of the DoWorkEventArgs
   // object. This is will be available to the 
   // RunWorkerCompleted eventhandler.
   e->Result = ComputeFibonacci( safe_cast<Int32>(e->Argument), worker, e );
}
// This event handler is where the actual,
// potentially time-consuming work is done.
private void backgroundWorker1_DoWork(object sender, 
    DoWorkEventArgs e)
{   
    // Get the BackgroundWorker that raised this event.
    BackgroundWorker worker = sender as BackgroundWorker;

    // Assign the result of the computation
    // to the Result property of the DoWorkEventArgs
    // object. This is will be available to the 
    // RunWorkerCompleted eventhandler.
    e.Result = ComputeFibonacci((int)e.Argument, worker, e);
}
' This event handler is where the actual work is done.
Private Sub backgroundWorker1_DoWork( _
ByVal sender As Object, _
ByVal e As DoWorkEventArgs) _
Handles backgroundWorker1.DoWork

    ' Get the BackgroundWorker object that raised this event.
    Dim worker As BackgroundWorker = _
        CType(sender, BackgroundWorker)

    ' Assign the result of the computation
    ' to the Result property of the DoWorkEventArgs
    ' object. This is will be available to the 
    ' RunWorkerCompleted eventhandler.
    e.Result = ComputeFibonacci(e.Argument, worker, e)
End Sub

Hinweise

Dieses Ereignis wird ausgelöst, wenn Sie die RunWorkerAsync-Methode aufzurufen.This event is raised when you call the RunWorkerAsync method. An dieser Stelle starten Sie den Vorgang, der die potenziell zeitaufwändige Arbeit ausführt.This is where you start the operation that performs the potentially time-consuming work.

Der Code im DoWork Ereignishandler sollte den CancellationPending-Eigenschafts Wert regelmäßig überprüfen und den Vorgang abbrechen, wenn er trueist.Your code in the DoWork event handler should periodically check the CancellationPending property value and abort the operation if it is true. Wenn dies auftritt, können Sie das Cancel-Flag von System.ComponentModel.DoWorkEventArgs auf truefestlegen, und das Cancelled-Flag System.ComponentModel.RunWorkerCompletedEventArgs in Ihrem RunWorkerCompleted-Ereignishandler wird auf truefestgelegt.When this occurs, you can set the Cancel flag of System.ComponentModel.DoWorkEventArgs to true, and the Cancelled flag of System.ComponentModel.RunWorkerCompletedEventArgs in your RunWorkerCompleted event handler will be set to true.

Achtung

Beachten Sie, dass der Code im DoWork Ereignishandler seine Arbeit beenden kann, wenn eine Abbruch Anforderung ausgeführt wird, und ihre Abruf Schleife kann übersehen, dass CancellationPending auf truefestgelegt wird.Be aware that your code in the DoWork event handler may finish its work as a cancellation request is being made, and your polling loop may miss CancellationPending being set to true. In diesem Fall wird das Cancelled-Flag System.ComponentModel.RunWorkerCompletedEventArgs im RunWorkerCompleted Ereignishandler nicht auf truefestgelegt, obwohl eine Abbruch Anforderung erfolgt ist.In this case, the Cancelled flag of System.ComponentModel.RunWorkerCompletedEventArgs in your RunWorkerCompleted event handler will not be set to true, even though a cancellation request was made. Diese Situation wird als Racebedingung bezeichnet und ist ein häufiges Problem bei der Multithreadprogrammierung.This situation is called a race condition and is a common concern in multithreaded programming. Weitere Informationen zu Problemen beim Entwerfen von Multithreading finden Sie unter bewährte Methoden für das verwaltete Threading.For more information about multithreading design issues, see Managed Threading Best Practices.

Wenn Ihr Vorgang ein Ergebnis erzeugt, können Sie das Ergebnis der DoWorkEventArgs.Result-Eigenschaft zuweisen.If your operation produces a result, you can assign the result to the DoWorkEventArgs.Result property. Diese ist für den RunWorkerCompleted-Ereignishandler in der RunWorkerCompletedEventArgs.Result-Eigenschaft verfügbar.This will be available to the RunWorkerCompleted event handler in the RunWorkerCompletedEventArgs.Result property.

Wenn der Vorgang eine Ausnahme auslöst, die der Code nicht behandelt, fängt der BackgroundWorker die Ausnahme ab und übergibt sie an den RunWorkerCompleted-Ereignishandler, wo er als Error-Eigenschaft des System.ComponentModel.RunWorkerCompletedEventArgsverfügbar gemacht wird.If the operation raises an exception that your code does not handle, the BackgroundWorker catches the exception and passes it into the RunWorkerCompleted event handler, where it is exposed as the Error property of System.ComponentModel.RunWorkerCompletedEventArgs. Wenn Sie unter dem Visual Studio-Debugger ausgeführt werden, unterbricht der Debugger an der Stelle im DoWork Ereignishandler, an dem die nicht behandelte Ausnahme ausgelöst wurde.If you are running under the Visual Studio debugger, the debugger will break at the point in the DoWork event handler where the unhandled exception was raised. Wenn Sie mehr als eine BackgroundWorkerhaben, sollten Sie nicht direkt darauf verweisen, da dadurch der DoWork-Ereignishandler mit einer bestimmten Instanz von BackgroundWorkerkoppeln würde.If you have more than one BackgroundWorker, you should not reference any of them directly, as this would couple your DoWork event handler to a specific instance of BackgroundWorker. Stattdessen sollten Sie auf Ihre BackgroundWorker zugreifen, indem Sie den sender-Parameter in den DoWork-Ereignishandler umwandeln.Instead, you should access your BackgroundWorker by casting the sender parameter in your DoWork event handler.

Sie müssen darauf achten, dass Sie keine Benutzeroberflächen Objekte in Ihrem DoWork-Ereignishandler bearbeiten.You must be careful not to manipulate any user-interface objects in your DoWork event handler. Kommunizieren Sie stattdessen über die BackgroundWorker Ereignisse mit der Benutzeroberfläche.Instead, communicate to the user interface through the BackgroundWorker events.

Weitere Informationen zum Behandeln von Ereignissen finden Sie unter behandeln und Auslösen von Ereignissen.For more information about how to handle events, see Handling and Raising Events.

Gilt für:

Siehe auch