RunWorkerCompletedEventArgs Klasse

Definition

public ref class RunWorkerCompletedEventArgs : System::ComponentModel::AsyncCompletedEventArgs

public class RunWorkerCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs

type RunWorkerCompletedEventArgs = class
    inherit AsyncCompletedEventArgs

Public Class RunWorkerCompletedEventArgs
Inherits AsyncCompletedEventArgs

Vererbung

Object

EventArgs

AsyncCompletedEventArgs

RunWorkerCompletedEventArgs

Beispiele

Das folgende Codebeispiel veranschaulicht die Verwendung von RunWorkerCompletedEventArgs. Dieses Beispiel ist Teil eines größeren Beispiels für die BackgroundWorker Klasse.

// This event handler deals with the results of the
// background operation.
void backgroundWorker1_RunWorkerCompleted( Object^ /*sender*/, RunWorkerCompletedEventArgs^ e )
{
   // First, handle the case where an exception was thrown.
   if ( e->Error != nullptr )
   {
      MessageBox::Show( e->Error->Message );
   }
   else
   if ( e->Cancelled )
   {
      // Next, handle the case where the user cancelled 
      // the operation.
      // Note that due to a race condition in 
      // the DoWork event handler, the Cancelled
      // flag may not have been set, even though
      // CancelAsync was called.
      resultLabel->Text = "Cancelled";
   }
   else
   {
      // Finally, handle the case where the operation 
      // succeeded.
      resultLabel->Text = e->Result->ToString();
   }

   // Enable the UpDown control.
   this->numericUpDown1->Enabled = true;

   // Enable the Start button.
   startAsyncButton->Enabled = true;

   // Disable the Cancel button.
   cancelAsyncButton->Enabled = false;
}

// This event handler deals with the results of the
// background operation.
void backgroundWorker1_RunWorkerCompleted(
    object sender, RunWorkerCompletedEventArgs e)
{
    // First, handle the case where an exception was thrown.
    if (e.Error != null)
    {
        _ = MessageBox.Show(e.Error.Message);
    }
    else if (e.Cancelled)
    {
        // Next, handle the case where the user canceled 
        // the operation.
        // Note that due to a race condition in 
        // the DoWork event handler, the Cancelled
        // flag may not have been set, even though
        // CancelAsync was called.
        resultLabel.Text = "Canceled";
    }
    else
    {
        // Finally, handle the case where the operation 
        // succeeded.
        resultLabel.Text = e.Result.ToString();
    }

    // Enable the UpDown control.
    numericUpDown1.Enabled = true;

    // Enable the Start button.
    startAsyncButton.Enabled = true;

    // Disable the Cancel button.
    cancelAsyncButton.Enabled = false;
}

' This event handler deals with the results of the
' background operation.
Private Sub backgroundWorker1_RunWorkerCompleted(
ByVal sender As Object, ByVal e As RunWorkerCompletedEventArgs) _
Handles backgroundWorker1.RunWorkerCompleted

    ' First, handle the case where an exception was thrown.
    If (e.Error IsNot Nothing) Then
        MessageBox.Show(e.Error.Message)
    ElseIf e.Cancelled Then
        ' Next, handle the case where the user canceled the 
        ' operation.
        ' Note that due to a race condition in 
        ' the DoWork event handler, the Cancelled
        ' flag may not have been set, even though
        ' CancelAsync was called.
        resultLabel.Text = "Canceled"
    Else
        ' Finally, handle the case where the operation succeeded.
        resultLabel.Text = e.Result.ToString()
    End If

    ' Enable the UpDown control.
    numericUpDown1.Enabled = True

    ' Enable the Start button.
    startAsyncButton.Enabled = True

    ' Disable the Cancel button.
    cancelAsyncButton.Enabled = False
End Sub

Hinweise

Bei Verwendung des ereignisbasierten asynchronen Musters für asynchrone Vorgänge initiiert ein Windows Forms-Formular oder -Steuerelement einen asynchronen Vorgang durch Aufrufen der BackgroundWorker.RunWorkerAsync Methode. Die Methode löst das BackgroundWorker.DoWork Ereignis wiederum asynchron aus und übergibt es eine DoWorkEventArgs Instanz. Wenn der asynchrone Vorgang einen Wert zurückgibt, weist der Ereignishandler ihn in der BackgroundWorker.DoWork Regel der DoWorkEventArgs.Result Eigenschaft zu. Nach Abschluss des asynchronen Vorgangs wird das BackgroundWorker.RunWorkerCompleted Ereignis ausgelöst und eine RunWorkerCompletedEventArgs Instanz übergeben, die Informationen zum Status des Vorgangs enthält (unabhängig davon, ob er abgebrochen, fehlerhaft oder erfolgreich abgeschlossen wurde). Wenn sie erfolgreich abgeschlossen wurde, enthält die Result Eigenschaft den Wert, der vom asynchronen Vorgang zurückgegeben und der DoWorkEventArgs.Result Eigenschaft zuvor zugewiesen wurde.

Weitere Informationen

• BackgroundWorker
• So führen Sie einen Vorgang im Hintergrund aus
• Vorgehensweise: Herunterladen einer Datei im Hintergrund