BackgroundWorker.CancelAsync メソッド

定義

保留中のバックグラウンド操作のキャンセルを要求します。Requests cancellation of a pending background operation.

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

例外

次のコード例は、CancelAsync メソッドを使用して、非同期 ("バックグラウンド") 操作をキャンセルする方法を示しています。The following code example demonstrates the use of the CancelAsync method to cancel an asynchronous ("background") operation. このコード例は、BackgroundWorker クラス用に用意されている大規模な例の一部です。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

注釈

CancelAsync は、保留中のバックグラウンド操作を終了する要求を送信し、CancellationPending プロパティを trueに設定します。CancelAsync submits a request to terminate the pending background operation and sets the CancellationPending property to true.

CancelAsyncを呼び出すと、ワーカーメソッドは実行を停止して終了することができます。When you call CancelAsync, your worker method has an opportunity to stop its execution and exit. ワーカーコードは、CancellationPending プロパティを定期的にチェックして、trueに設定されているかどうかを確認する必要があります。The worker code should periodically check the CancellationPending property to see if it has been set to true.

注意事項

キャンセル要求の実行中に、DoWork イベントハンドラーのコードが作業を終了する可能性があることに注意してください。ポーリングループが CancellationPending trueに設定されている可能性があります。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. この場合、キャンセル要求が行われた場合でも、RunWorkerCompleted イベントハンドラーの System.ComponentModel.RunWorkerCompletedEventArgsCancelled フラグは trueに設定されません。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. この状況は競合状態と呼ばれ、マルチスレッドプログラミングの一般的な問題です。This situation is called a race condition and is a common concern in multithreaded programming. マルチスレッドのデザインの問題の詳細については、「マネージスレッド処理のベストプラクティス」を参照してください。For more information about multithreading design issues, see Managed Threading Best Practices.

適用対象

こちらもご覧ください