BackgroundWorker.RunWorkerAsync Method (Object) (System.ComponentModel)

RunWorkerAsync Method (Object)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

BackgroundWorker..::.RunWorkerAsync Method (Object)

Updated: November 2007

Starts execution of a background operation.

Namespace: System.ComponentModel
Assembly: System (in System.dll)

Syntax

Visual Basic (Declaration)

Public Sub RunWorkerAsync ( _
    argument As Object _
)

Visual Basic (Usage)

Dim instance As BackgroundWorker
Dim argument As Object

instance.RunWorkerAsync(argument)

public void RunWorkerAsync(
    Object argument
)

Visual C++

public:
void RunWorkerAsync(
    Object^ argument
)

public void RunWorkerAsync(
    Object argument
)

JScript

public function RunWorkerAsync(
    argument : Object
)

Parameters

argument: Type: System..::.Object
A parameter for use by the background operation to be executed in the DoWork event handler.

Exceptions

Exception	Condition
InvalidOperationException	IsBusy is true.

Remarks

The RunWorkerAsync method submits a request to start the operation running asynchronously. When the request is serviced, the DoWork event is raised, which in turn starts execution of your background operation.

If your operation requires a parameter, you can provide it as the argument parameter to RunWorkerAsync.

If the background operation is already running, calling RunWorkerAsync again will raise an InvalidOperationException.

Examples

The following code example demonstrates the use of the RunWorkerAsync method to start an asynchronous operation. This code example is part of a larger example provided for the BackgroundWorker class.

Visual Basic

' Start the asynchronous operation.
backgroundWorker1.RunWorkerAsync(numberToCompute)

// Start the asynchronous operation.
backgroundWorker1.RunWorkerAsync(numberToCompute);

Visual C++

// Start the asynchronous operation.
backgroundWorker1->RunWorkerAsync( numberToCompute );

// Start the asynchronous operation.
backgroundWorker1.RunWorkerAsync(System.Convert.ToString
    (numberToCompute));

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information