ThreadPool.QueueUserWorkItem

.NET Framework クラス ライブラリ リファレンス

ThreadPool.QueueUserWorkItem メソッド (WaitCallback, Object)

実行するためのキューにメソッドを置き、そのメソッドが使用するデータを含んだオブジェクトを指定します。メソッドは、スレッド プールのスレッドが使用可能になったときに実行されます。

名前空間: System.Threading
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Shared Function QueueUserWorkItem
 ( _
    callBack As WaitCallback, _
    state As Object _
) As Boolean

Visual Basic (使用法)

Dim callBack As WaitCallback
Dim state As Object
Dim returnValue As Boolean

returnValue = ThreadPool.QueueUserWorkItem(callBack, state)

C#

public static bool QueueUserWorkItem
 (
    WaitCallback callBack,
    Object state
)

C++

public:
static bool QueueUserWorkItem (
    WaitCallback^ callBack, 
    Object^ state
)

J#

public static boolean QueueUserWorkItem (
    WaitCallback callBack, 
    Object state
)

JScript

public static function QueueUserWorkItem
 (
    callBack : WaitCallback, 
    state : Object
) : boolean

パラメータ

callBack

実行するメソッドを表す WaitCallback。

state

メソッドが使用するデータを格納したオブジェクト。

戻り値
このメソッドが正常にキューに置かれた場合は true。それ以外の場合は false。

例外

例外の種類	条件
ApplicationException	メモリが不足しています。

解説

複雑なデータをコールバック メソッドが要求する場合は、データを格納するためのクラスを定義できます。

メモ
Visual Basic のユーザーは WaitCallback コンストラクタを省略できます。コールバック メソッドを QueueUserWorkItem に渡すときは単純に AddressOf 演算子を使用できます。Visual Basic は正しいデリゲート コンストラクタを自動的に呼び出します。

バージョン情報

.NET Framework Version 2.0 では、Thread.CurrentPrincipal プロパティの値が、QueueUserWorkItem メソッドを使用してキューに置かれたワーカー スレッドに反映されます。旧バージョンでは、プリンシパル情報が反映されません。

使用例

Visual Basic

Imports System
Imports System.Threading

Public Class Example

    <MTAThread> _
    Public Shared Sub Main()
        ' Queue the task.
        ThreadPool.QueueUserWorkItem( _
            New WaitCallback(AddressOf ThreadProc)
 _
            )
        ' Note that you do not have to create the WaitCallback delegate
        ' explicitly in Visual Basic.  The following line also queues
 
        ' the task:
        'ThreadPool.QueueUserWorkItem(AddressOf ThreadProc)
        
        Console.WriteLine("Main thread does some work, then sleeps.")
        ' If you comment out the Sleep, the main thread exits before
        ' the thread pool task runs.  The thread pool 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.")
    End Sub

    ' This thread procedure performs the task.
    Shared Sub ThreadProc(stateInfo As
 Object)
        ' No state object was passed to QueueUserWorkItem, so 
        ' stateInfo is null.
        Console.WriteLine("Hello from the thread pool.")
    End Sub
End Class

C#

using System;
using System.Threading;
public class Example {
    public static void Main()
 {
        // Queue the task.
        ThreadPool.QueueUserWorkItem(new WaitCallback(ThreadProc));
        
        Console.WriteLine("Main thread does some work, then sleeps.");
        // If you comment out the Sleep, the main thread exits before
        // the thread pool task runs.  The thread pool 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.");
    }

    // This thread procedure performs the task.
    static void ThreadProc(Object stateInfo)
 {
        // No state object was passed to QueueUserWorkItem, so 
        // stateInfo is null.
        Console.WriteLine("Hello from the thread pool.");
    }
}

C++

using namespace System;
using namespace System::Threading;
ref class Example
{
public:

   // This thread procedure performs the task.
   static void ThreadProc( Object^ stateInfo
 )
   {
      
      // No state object was passed to QueueUserWorkItem, so 
      // stateInfo is 0.
      Console::WriteLine( "Hello from the thread pool." );
   }

};

int main()
{
   
   // Queue the task.
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( Example::ThreadProc ) );
   Console::WriteLine( "Main thread does some work, then sleeps." );
   
   // If you comment out the Sleep, the main thread exits before
   // the thread pool task runs.  The thread pool 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." );
   return 0;
}

J#

import System.*;
import System.Threading.*;
import System.Threading.Thread;

public class Example
{
    public static void main(String[]
 args)
    {
        // Queue the task.
        ThreadPool.QueueUserWorkItem(new WaitCallback(ThreadProc));
        Console.WriteLine("Main thread does some work, then sleeps.");

        // If you comment out the Sleep, the main thread exits before
        // the thread pool task runs.  The thread pool 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.");
    } //main

    // This thread procedure performs the task.
    static void ThreadProc(Object stateInfo)
    {
        // No state object was passed to QueueUserWorkItem, so 
        // stateInfo is null.
        Console.WriteLine("Hello from the thread pool.");
    } //ThreadProc
} //Example

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
ThreadPool クラス
ThreadPool メンバ
System.Threading 名前空間
その他の技術情報
マネージ スレッド プール

ThreadPool.QueueUserWorkItem メソッド (WaitCallback)

メソッドを実行するためのキューに置きます。メソッドは、スレッド プールのスレッドが使用可能になったときに実行されます。

名前空間: System.Threading
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Shared Function QueueUserWorkItem
 ( _
    callBack As WaitCallback _
) As Boolean

Visual Basic (使用法)

Dim callBack As WaitCallback
Dim returnValue As Boolean

returnValue = ThreadPool.QueueUserWorkItem(callBack)

C#

public static bool QueueUserWorkItem
 (
    WaitCallback callBack
)

C++

public:
static bool QueueUserWorkItem (
    WaitCallback^ callBack
)

J#

public static boolean QueueUserWorkItem (
    WaitCallback callBack
)

JScript

public static function QueueUserWorkItem
 (
    callBack : WaitCallback
) : boolean

パラメータ

callBack

実行するメソッドを表す WaitCallback。

戻り値
このメソッドが正常にキューに置かれた場合は true。それ以外の場合は false。

例外

例外の種類	条件
ApplicationException	メモリが不足しています。

解説

キューに置かれたメソッドで必要となるデータは、メソッドを定義しているクラスのインスタンス フィールドに格納することもできますし、必要なデータを格納したオブジェクトを受け取る QueueUserWorkItem オーバーロードを使用することもできます。

メモ
Visual Basic のユーザーは WaitCallback コンストラクタを省略できます。コールバック メソッドを QueueUserWorkItem に渡すときは単純に AddressOf 演算子を使用できます。Visual Basic は正しいデリゲート コンストラクタを自動的に呼び出します。

バージョン情報

.NET Framework Version 2.0 では、Thread.CurrentPrincipal プロパティの値が、QueueUserWorkItem メソッドを使用してキューに置かれたワーカー スレッドに反映されます。旧バージョンでは、プリンシパル情報が反映されません。

使用例

Visual Basic

' 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.
Imports System
Imports System.Threading
' TaskInfo holds state information for a task that will be
' executed by a ThreadPool thread.
Public Class TaskInfo
    ' State information for the task.  These members
    ' can be implemented as read-only properties, read/write
    ' properties with validation, and so on, as required.
    Public Boilerplate As String
    Public Value As Integer

    ' Public constructor provides an easy way to supply all
    ' the information needed for the task.
    Public Sub New(text
 As String, number As Integer)
        Boilerplate = text
        Value = number
    End Sub
End Class

Public Class Example

    <MTAThread> _
    Public Shared Sub Main()
        ' Create an object containing the information needed
        ' for the task.
        Dim ti As New TaskInfo("This
 report displays the number {0}.", 42)

        ' Queue the task and data.
        If ThreadPool.QueueUserWorkItem( _
            New WaitCallback(AddressOf ThreadProc),
 ti) Then
        
            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.")
        Else
            Console.WriteLine("Unable to queue ThreadPool request.")
        End If
    End Sub

    ' The thread procedure performs the independent task, in this case
    ' formatting and printing a very simple report.
    '
    Shared Sub ThreadProc(stateInfo As
 Object)
        Dim ti As TaskInfo = CType(stateInfo,
 TaskInfo)
        Console.WriteLine(ti.Boilerplate, ti.Value)
    End Sub
End Class

C#

// 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 System;
using System.Threading;

// TaskInfo holds state information for a task that will be
// executed by a ThreadPool thread.
public class TaskInfo {
    // State information for the task.  These members
    // can be implemented as read-only properties, read/write
    // properties with validation, and so on, as required.
    public string Boilerplate;
    public int Value;

    // Public constructor provides an easy way to supply all
    // the information needed for the task.
    public TaskInfo(string text, int
 number) {
        Boilerplate = text;
        Value = number;
    }
}

public class Example {
    public static void Main()
 {
        // Create an object containing the information needed
        // for the task.
        TaskInfo ti = new TaskInfo("This report displays
 the number {0}.", 42);

        // Queue the task and data.
        if (ThreadPool.QueueUserWorkItem(new
 WaitCallback(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.");
        }
        else {
            Console.WriteLine("Unable to queue ThreadPool request."); 
        }
    }

    // The thread procedure performs the independent task, in this case
    // formatting and printing a very simple report.
    //
    static void ThreadProc(Object stateInfo)
 {
        TaskInfo ti = (TaskInfo) stateInfo;
        Console.WriteLine(ti.Boilerplate, ti.Value); 
    }
}

C++

// 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 );
   }

};

int 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.
   if ( 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." );
   }
   else
   {
      Console::WriteLine( "Unable to queue ThreadPool request." );
   }

   return 0;
}

J#

// 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.
import System.*;
import System.Threading.*;
import System.Threading.Thread;

// TaskInfo holds state information for a task that will be
// executed by a ThreadPool thread.
public class TaskInfo
{
    // State information for the task.  These members
    // can be implemented as read-only properties, read/write
    // properties with validation, and so on, as required.
    public String boilerplate;
    public int value;

    // Public constructor provides an easy way to supply all
    // the information needed for the task.
    public TaskInfo(String text, int number)
    {
        boilerplate = text;
        value = number;
    } //TaskInfo
} //TaskInfo

public class Example
{
    public static void main(String[]
 args)
    {
        // Create an object containing the information needed
        // for the task.
        TaskInfo ti = new TaskInfo("This report displays
 the number {0}.", 42);

        // Queue the task and data.
        if (ThreadPool.QueueUserWorkItem(new
 WaitCallback(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.");
        }
        else {
            Console.WriteLine("Unable to queue ThreadPool request.");
        }
    } //main

    // The thread procedure performs the independent task, in this case
    // formatting and printing a very simple report.
    //
    static void ThreadProc(Object stateInfo)
    {
        TaskInfo ti = ((TaskInfo)(stateInfo));

        Console.WriteLine(ti.boilerplate, String.valueOf(ti.value));
    } //ThreadProc
} //Example

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
ThreadPool クラス
ThreadPool メンバ
System.Threading 名前空間
その他の技術情報
マネージ スレッド プール

ThreadPool.QueueUserWorkItem メソッド

メソッドを実行するためのキューに置きます。メソッドは、スレッド プールのスレッドが使用可能になったときに実行されます。
オーバーロードの一覧

名前	説明
ThreadPool.QueueUserWorkItem (WaitCallback)	メソッドを実行するためのキューに置きます。メソッドは、スレッド プールのスレッドが使用可能になったときに実行されます。 .NET Compact Framework によってサポートされています。
ThreadPool.QueueUserWorkItem (WaitCallback, Object)	実行するためのキューにメソッドを置き、そのメソッドが使用するデータを含んだオブジェクトを指定します。メソッドは、スレッド プールのスレッドが使用可能になったときに実行されます。 .NET Compact Framework によってサポートされています。

参照

関連項目

ThreadPool クラス
ThreadPool メンバ
System.Threading 名前空間

その他の技術情報

マネージ スレッド プール