ThreadPool::QueueUserWorkItem Method (WaitCallback, Object)
Queues a method for execution, and specifies an object containing data to be used by the method. The method executes when a thread pool thread becomes available.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- callBack
- Type: System.Threading::WaitCallback
A WaitCallback representing the method to execute.
- state
- Type: System::Object
An object containing data to be used by the method.
Return Value
Type: System::Booleantrue if the method is successfully queued; NotSupportedException is thrown if the work item could not be queued.
| Exception | Condition |
|---|---|
| NotSupportedException | The common language runtime (CLR) is hosted, and the host does not support this action. |
| ArgumentNullException | callBack is nullptr. |
If the callback method requires complex data, you can define a class to contain the data.
Note |
|---|
Visual Basic users can omit the WaitCallback constructor, and simply use the AddressOf operator when passing the callback method to QueueUserWorkItem. Visual Basic automatically calls the correct delegate constructor. |
Version Information
In the .NET Framework version 2.0, the Thread::CurrentPrincipal property value is propagated to worker threads queued using the QueueUserWorkItem method. In earlier versions, the principal information is not propagated.
The following example shows how to create an object that contains task information. It also demonstrates how to pass that object to a task that is queued for execution by the thread pool.
// This example shows how to create an Object* containing task // information, and pass that Object* to a task queued for // execution by the thread pool. using namespace System; using namespace System::Threading; // TaskInfo holds state information for a task that will be // executed by a ThreadPool thread. public ref class TaskInfo { public: // State information for the task. These members // can be implemented as read-only properties, read/write // properties with validation, and so on, as required. String^ Boilerplate; int Value; // Public constructor provides an easy way to supply all // the information needed for the task. TaskInfo( String^ text, int number ) { Boilerplate = text; Value = number; } }; public ref struct Example { public: // The thread procedure performs the independent task, in this case // formatting and printing a very simple report. // static void ThreadProc( Object^ stateInfo ) { TaskInfo^ ti = dynamic_cast<TaskInfo^>(stateInfo); Console::WriteLine( ti->Boilerplate, ti->Value ); } }; void main() { // Create an object containing the information needed // for the task. TaskInfo^ ti = gcnew TaskInfo( "This report displays the number {0}.",42 ); // Queue the task and data. ThreadPool::QueueUserWorkItem( gcnew WaitCallback( Example::ThreadProc ), ti ); Console::WriteLine( "Main thread does some work, then sleeps." ); // If you comment out the Sleep, the main thread exits before // the ThreadPool task has a chance to run. ThreadPool uses // background threads, which do not keep the application // running. (This is a simple example of a race condition.) Thread::Sleep( 1000 ); Console::WriteLine( "Main thread exits." ); }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note