BackgroundWorker.RunWorkerCompleted Zdarzenie

Definicja

Przestrzeń nazw:

System.ComponentModel

Zestaw:

System.ComponentModel.EventBasedAsync.dll

Źródło:

BackgroundWorker.cs

Występuje, gdy operacja w tle została zakończona, została anulowana lub zgłosiła wyjątek.

public:
 event System::ComponentModel::RunWorkerCompletedEventHandler ^ RunWorkerCompleted;

public event System.ComponentModel.RunWorkerCompletedEventHandler? RunWorkerCompleted;

member this.RunWorkerCompleted : System.ComponentModel.RunWorkerCompletedEventHandler 

Public Custom Event RunWorkerCompleted As RunWorkerCompletedEventHandler 

Typ zdarzenia

RunWorkerCompletedEventHandler

Przykłady

Poniższy przykład kodu pokazuje użycie RunWorkerCompleted zdarzenia do obsługi wyniku operacji asynchronicznej. Ten przykład kodu jest częścią większego przykładu podanego BackgroundWorker dla klasy.

// 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.
private 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.
    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.
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.
    Me.numericUpDown1.Enabled = True

    ' Enable the Start button.
    startAsyncButton.Enabled = True

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

Uwagi

To zdarzenie jest zgłaszane po powrocie programu obsługi zdarzeń DoWork .

Jeśli operacja zakończy się pomyślnie, a jej wynik zostanie przypisany w procedurze DoWork obsługi zdarzeń, możesz uzyskać dostęp do wyniku za pośrednictwem RunWorkerCompletedEventArgs.Result właściwości.

Właściwość Error elementu System.ComponentModel.RunWorkerCompletedEventArgs wskazuje, że wyjątek został zgłoszony przez operację.

Właściwość Cancelled parametru System.ComponentModel.RunWorkerCompletedEventArgs wskazuje, czy żądanie anulowania zostało przetworzone przez operację w tle. Jeśli kod w procedurze obsługi zdarzeń DoWork wykryje żądanie anulowania, sprawdzając CancellationPending flagę i ustawiając Cancel flagę na , Cancelled flaga System.ComponentModel.RunWorkerCompletedEventArgsSystem.ComponentModel.DoWorkEventArgstruerównież zostanie ustawiona na .true

Przestroga

Należy pamiętać, że kod w procedurze DoWork obsługi zdarzeń może zakończyć pracę, ponieważ jest wykonywane żądanie anulowania, a pętla sondowania może przegapić CancellationPendingtrueustawienie . W takim przypadku flaga CancelledSystem.ComponentModel.RunWorkerCompletedEventArgs programu RunWorkerCompleted obsługi zdarzeń nie zostanie ustawiona na truewartość , mimo że zostało wykonane żądanie anulowania. Ta sytuacja jest nazywana warunkiem wyścigu i jest powszechnym problemem w programowaniu wielowątkowym. Aby uzyskać więcej informacji na temat problemów z projektowaniem wielowątkowym, zobacz Managed Threading Best Practices (Najlepsze rozwiązania dotyczące zarządzania wątkami zarządzanymi).

Procedura RunWorkerCompleted obsługi zdarzeń powinna zawsze sprawdzać AsyncCompletedEventArgs.Error właściwości i AsyncCompletedEventArgs.Cancelled przed uzyskaniem RunWorkerCompletedEventArgs.Result dostępu do właściwości. Jeśli zgłoszono wyjątek lub jeśli operacja została anulowana, dostęp RunWorkerCompletedEventArgs.Result do właściwości zgłasza wyjątek.

Zobacz też

• Instrukcje: uruchamianie operacji w tle
• Instrukcje: pobieranie pliku w tle