RunWorkerCompletedEventArgs Klas

Definitie

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

public class RunWorkerCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs

type RunWorkerCompletedEventArgs = class
    inherit AsyncCompletedEventArgs

Public Class RunWorkerCompletedEventArgs
Inherits AsyncCompletedEventArgs

Overname

Object

EventArgs

AsyncCompletedEventArgs

RunWorkerCompletedEventArgs

Voorbeelden

Het volgende codevoorbeeld illustreert het gebruik van RunWorkerCompletedEventArgs. Dit voorbeeld maakt deel uit van een groter voorbeeld voor de 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

Opmerkingen

Wanneer u het op event gebaseerde asynchrone patroon gebruikt voor asynchrone bewerkingen, start een Windows Forms formulier of besturingselement een asynchrone bewerking door de methode BackgroundWorker.RunWorkerAsync aan te roepen. Met de methode wordt de BackgroundWorker.DoWork gebeurtenis asynchroon gegenereerd en doorgegeven aan een DoWorkEventArgs exemplaar. Als de asynchrone bewerking een waarde retourneert, wijst de BackgroundWorker.DoWork gebeurtenishandler deze doorgaans toe aan de DoWorkEventArgs.Result eigenschap. Wanneer de asynchrone bewerking is voltooid, wordt de BackgroundWorker.RunWorkerCompleted gebeurtenis gegenereerd en wordt een RunWorkerCompletedEventArgs exemplaar doorgegeven dat informatie bevat over de status van de bewerking (of deze is geannuleerd, mislukt of voltooid). Als deze is voltooid, Result bevat de eigenschap de waarde die wordt geretourneerd door de asynchrone bewerking en eerder toegewezen aan de DoWorkEventArgs.Result eigenschap.

Zie ook

• BackgroundWorker
• Handleiding: Een bewerking uitvoeren op de achtergrond
• Procedure: Een bestand downloaden op de achtergrond