BackgroundWorker.CancelAsync BackgroundWorker.CancelAsync BackgroundWorker.CancelAsync BackgroundWorker.CancelAsync Method

Definición

Solicita la cancelación de una operación en segundo plano pendiente.Requests cancellation of a pending background operation.

public:
 void CancelAsync();
public void CancelAsync ();
member this.CancelAsync : unit -> unit
Public Sub CancelAsync ()

Excepciones

Ejemplos

En el ejemplo de código siguiente se muestra el CancelAsync uso del método para cancelar una operación asincrónica ("en segundo plano").The following code example demonstrates the use of the CancelAsync method to cancel an asynchronous ("background") operation. Este ejemplo de código forma parte de un ejemplo más extenso proporcionado BackgroundWorker para la clase.This code example is part of a larger example provided for the BackgroundWorker class.

void cancelAsyncButton_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{  
   // Cancel the asynchronous operation.
   this->backgroundWorker1->CancelAsync();
   
   // Disable the Cancel button.
   cancelAsyncButton->Enabled = false;
}
private void cancelAsyncButton_Click(System.Object sender, 
    System.EventArgs e)
{   
    // Cancel the asynchronous operation.
    this.backgroundWorker1.CancelAsync();

    // Disable the Cancel button.
    cancelAsyncButton.Enabled = false;
}
Private Sub cancelAsyncButton_Click( _
ByVal sender As System.Object, _
ByVal e As System.EventArgs) _
Handles cancelAsyncButton.Click
    
    ' Cancel the asynchronous operation.
    Me.backgroundWorker1.CancelAsync()

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

Comentarios

CancelAsyncenvía una solicitud para finalizar la operación en segundo plano pendiente y establece CancellationPending la propiedad trueen.CancelAsync submits a request to terminate the pending background operation and sets the CancellationPending property to true.

Cuando se llama CancelAsynca, el método de trabajo tiene la oportunidad de detener su ejecución y salir.When you call CancelAsync, your worker method has an opportunity to stop its execution and exit. El código de trabajo debe comprobar periódicamente CancellationPending la propiedad para ver si se ha establecido en true.The worker code should periodically check the CancellationPending property to see if it has been set to true.

Precaución

Tenga en cuenta que el código del DoWork controlador de eventos puede finalizar su trabajo a medida que se realiza una solicitud de cancelación y CancellationPending que es posible que el bucle de truesondeo no se establezca en.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. En este caso, la Cancelled marca de System.ComponentModel.RunWorkerCompletedEventArgs en el RunWorkerCompleted controlador de eventos no se establecerá trueen, aunque se realizó una solicitud de cancelación.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. Esta situación se denomina condición de carrera y es un problema habitual en la programación multiproceso.This situation is called a race condition and is a common concern in multithreaded programming. Para obtener más información sobre los problemas de diseño de multithreading, vea procedimientos recomendados para el subprocesamiento administrado.For more information about multithreading design issues, see Managed Threading Best Practices.

Se aplica a

Consulte también: