BackgroundWorker.DoWork BackgroundWorker.DoWork BackgroundWorker.DoWork BackgroundWorker.DoWork Event

定義

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 'backgroundWorker1_DoWork

注釈

このイベントを呼び出すときに発生しますが、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. これが発生したときに設定できます、CancelフラグSystem.ComponentModel.DoWorkEventArgstrue、およびCancelledフラグSystem.ComponentModel.RunWorkerCompletedEventArgsで、RunWorkerCompletedイベント ハンドラーに設定されますtrueWhen 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. ここで、CancelledフラグSystem.ComponentModel.RunWorkerCompletedEventArgsで、RunWorkerCompletedイベント ハンドラーは設定されません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. マルチ スレッド デザインの詳細については、問題を参照してくださいManaged Threading Best Practicesします。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. これは使用可能になります、RunWorkerCompleted内のイベント ハンドラー、RunWorkerCompletedEventArgs.Resultプロパティ。This will be available to the RunWorkerCompleted event handler in the RunWorkerCompletedEventArgs.Result property.

操作が、コードを処理は、例外が発生した場合、BackgroundWorkerが例外をキャッチし、これに、RunWorkerCompletedとして公開される、イベント ハンドラー、ErrorプロパティのSystem.ComponentModel.RunWorkerCompletedEventArgsします。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. 1 つ以上ある場合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. 代わりに、アクセスする必要があります、BackgroundWorkerキャストすることによって、senderパラメーター、DoWorkイベント ハンドラー。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.

適用対象

こちらもご覧ください