BackgroundWorker.DoWork イベント

定義

RunWorkerAsync() が呼び出されたときに発生します。Occurs when RunWorkerAsync() is called.

public:
 event System::ComponentModel::DoWorkEventHandler ^ DoWork;
public event System.ComponentModel.DoWorkEventHandler DoWork;
member this.DoWork : System.ComponentModel.DoWorkEventHandler 
Public Custom Event DoWork As DoWorkEventHandler 

次のコード例は、DoWork イベントを使用して非同期操作を開始する方法を示しています。The following code example demonstrates the use of the DoWork event to start an asynchronous operation. このコード例は、BackgroundWorker クラス用に用意されている大規模な例の一部です。This code example is part of a larger example provided for the BackgroundWorker class.

// This event handler is where the actual,
// potentially time-consuming work is done.
void backgroundWorker1_DoWork( Object^ sender, DoWorkEventArgs^ e )
{
   // Get the BackgroundWorker that raised this event.
   BackgroundWorker^ worker = dynamic_cast<BackgroundWorker^>(sender);

   // Assign the result of the computation
   // to the Result property of the DoWorkEventArgs
   // object. This is will be available to the 
   // RunWorkerCompleted eventhandler.
   e->Result = ComputeFibonacci( safe_cast<Int32>(e->Argument), worker, e );
}
// This event handler is where the actual,
// potentially time-consuming work is done.
private void backgroundWorker1_DoWork(object sender, 
    DoWorkEventArgs e)
{   
    // Get the BackgroundWorker that raised this event.
    BackgroundWorker worker = sender as BackgroundWorker;

    // Assign the result of the computation
    // to the Result property of the DoWorkEventArgs
    // object. This is will be available to the 
    // RunWorkerCompleted eventhandler.
    e.Result = ComputeFibonacci((int)e.Argument, worker, e);
}
' This event handler is where the actual work is done.
Private Sub backgroundWorker1_DoWork( _
ByVal sender As Object, _
ByVal e As DoWorkEventArgs) _
Handles backgroundWorker1.DoWork

    ' Get the BackgroundWorker object that raised this event.
    Dim worker As BackgroundWorker = _
        CType(sender, BackgroundWorker)

    ' Assign the result of the computation
    ' to the Result property of the DoWorkEventArgs
    ' object. This is will be available to the 
    ' RunWorkerCompleted eventhandler.
    e.Result = ComputeFibonacci(e.Argument, worker, e)
End Sub

注釈

このイベントは、RunWorkerAsync メソッドを呼び出すと発生します。This event is raised when you call the RunWorkerAsync method. これは、時間のかかる可能性のある作業を実行する操作を開始する場所です。This is where you start the operation that performs the potentially time-consuming work.

DoWork イベントハンドラーのコードは、CancellationPending プロパティ値を定期的にチェックし、trueされている場合は操作を中止する必要があります。Your code in the DoWork event handler should periodically check the CancellationPending property value and abort the operation if it is true. この場合、System.ComponentModel.DoWorkEventArgsCancel フラグを trueに設定すると、System.ComponentModel.RunWorkerCompletedEventArgs イベントハンドラーの RunWorkerCompletedCancelled フラグが trueに設定されます。When this occurs, you can set the Cancel flag of System.ComponentModel.DoWorkEventArgs to true, and the Cancelled flag of System.ComponentModel.RunWorkerCompletedEventArgs in your RunWorkerCompleted event handler will be 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.

操作によって結果が生成された場合は、DoWorkEventArgs.Result プロパティに結果を割り当てることができます。If your operation produces a result, you can assign the result to the DoWorkEventArgs.Result property. これは、RunWorkerCompletedEventArgs.Result プロパティの RunWorkerCompleted イベントハンドラーで使用できます。This will be available to the RunWorkerCompleted event handler in the RunWorkerCompletedEventArgs.Result property.

操作によって処理されない例外が発生した場合、BackgroundWorker は例外をキャッチし、RunWorkerCompleted イベントハンドラーに渡します。このハンドラーは System.ComponentModel.RunWorkerCompletedEventArgsError プロパティとして公開されます。If the operation raises an exception that your code does not handle, the BackgroundWorker catches the exception and passes it into the RunWorkerCompleted event handler, where it is exposed as the Error property of System.ComponentModel.RunWorkerCompletedEventArgs. Visual Studio デバッガーで実行している場合、デバッガーは、ハンドルされない例外が発生した DoWork イベントハンドラーのポイントで中断します。If you are running under the Visual Studio debugger, the debugger will break at the point in the DoWork event handler where the unhandled exception was raised. 複数の BackgroundWorkerがある場合は、それを直接参照することはできません。これにより、DoWork のイベントハンドラーが BackgroundWorkerの特定のインスタンスに対して行われるためです。If you have more than one BackgroundWorker, you should not reference any of them directly, as this would couple your DoWork event handler to a specific instance of BackgroundWorker. 代わりに、DoWork イベントハンドラーで sender パラメーターをキャストすることによって、BackgroundWorker にアクセスする必要があります。Instead, you should access your BackgroundWorker by casting the sender parameter in your DoWork event handler.

DoWork イベントハンドラーでは、ユーザーインターフェイスオブジェクトを操作しないように注意する必要があります。You must be careful not to manipulate any user-interface objects in your DoWork event handler. 代わりに、BackgroundWorker イベントを使用してユーザーインターフェイスと通信します。Instead, communicate to the user interface through the BackgroundWorker events.

イベントを処理する方法の詳細については、次を参照してください。処理とイベントの発生します。For more information about how to handle events, see Handling and Raising Events.

適用対象

こちらもご覧ください