BackgroundWorker.RunWorkerCompleted Evento

Definição

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.EventBasedAsync.dll

Origem:

BackgroundWorker.cs

Ocorre quando a operação em segundo plano foi concluída, cancelada ou gerou uma exceção.

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

public event System.ComponentModel.RunWorkerCompletedEventHandler? RunWorkerCompleted;

member this.RunWorkerCompleted : System.ComponentModel.RunWorkerCompletedEventHandler 

Public Custom Event RunWorkerCompleted As RunWorkerCompletedEventHandler 

Tipo de evento

RunWorkerCompletedEventHandler

Exemplos

O exemplo de código a seguir demonstra o uso do RunWorkerCompleted evento para manipular o resultado de uma operação assíncrona. Este exemplo de código faz parte de um exemplo maior fornecido para a BackgroundWorker classe .

// 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

Comentários

Esse evento é gerado quando o DoWork manipulador de eventos retorna.

Se a operação for concluída com êxito e seu resultado for atribuído no DoWork manipulador de eventos, você poderá acessar o resultado por meio da RunWorkerCompletedEventArgs.Result propriedade .

A Error propriedade de System.ComponentModel.RunWorkerCompletedEventArgs indica que uma exceção foi gerada pela operação.

A Cancelled propriedade de System.ComponentModel.RunWorkerCompletedEventArgs indica se uma solicitação de cancelamento foi processada pela operação em segundo plano. Se o DoWork código no manipulador de eventos detectar uma solicitação de cancelamento verificando o CancellationPending sinalizador e definindo o Cancel sinalizador de System.ComponentModel.DoWorkEventArgs como true, o Cancelled sinalizador de System.ComponentModel.RunWorkerCompletedEventArgs também será definido truecomo .

Cuidado

Lembre-se de que seu DoWork código no manipulador de eventos pode concluir seu trabalho à medida que uma solicitação de cancelamento está sendo feita, e o loop de sondagem pode perder CancellationPending a definição como true. Nesse caso, o Cancelled sinalizador de System.ComponentModel.RunWorkerCompletedEventArgs em seu RunWorkerCompleted manipulador de eventos não será definido truecomo , mesmo que uma solicitação de cancelamento tenha sido feita. Essa situação é chamada de condição de corrida e é uma preocupação comum na programação multithread. Para obter mais informações sobre problemas de design multithreading, consulte Práticas recomendadas de threading gerenciado.

O RunWorkerCompleted manipulador de eventos deve sempre marcar as AsyncCompletedEventArgs.Error propriedades e AsyncCompletedEventArgs.Cancelled antes de acessar a RunWorkerCompletedEventArgs.Result propriedade . Se uma exceção tiver sido gerada ou se a operação tiver sido cancelada, acessar a RunWorkerCompletedEventArgs.Result propriedade gerará uma exceção.

Confira também

• Como: Executar uma operação em segundo plano
• Como: Como baixar um arquivo em segundo plano