Win32 API 日本語リファレンス
ホームSystem.Threading › QueueUserWorkItem

QueueUserWorkItem

関数
ワーカースレッドプールに作業項目をキューする。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL QueueUserWorkItem(
    LPTHREAD_START_ROUTINE Function,
    void* Context,   // optional
    WORKER_THREAD_FLAGS Flags
);

パラメーター

名前方向説明
FunctionLPTHREAD_START_ROUTINEin

スレッドプール内のスレッドによって実行される、LPTHREAD_START_ROUTINE 型のアプリケーション定義のコールバック関数へのポインター。この値はスレッドの開始アドレスを表します。このコールバック関数は TerminateThread 関数を呼び出してはなりません。

コールバック関数の戻り値は使用されません。

詳細については、 ThreadProc を参照してください。

Contextvoid*inoptionalスレッド関数に渡される単一のパラメーター値。
FlagsWORKER_THREAD_FLAGSin

実行を制御するフラグ。このパラメーターには、次の値を 1 つ以上指定できます。

意味
WT_EXECUTEDEFAULT
0x00000000
既定では、コールバック関数は非 I/O ワーカースレッドにキューイングされます。

コールバック関数は I/O 完了ポートを使用するスレッドにキューイングされるため、アラート可能な待機を実行できません。したがって、I/O が完了して APC が生成された場合、コールバックの完了後にスレッドがアラート可能な待機状態に入る保証がないため、APC が無期限に待機する可能性があります。

WT_EXECUTEINIOTHREAD
0x00000001
このフラグは使用されません。

Windows Server 2003 および Windows XP: コールバック関数は I/O ワーカースレッドにキューイングされます。このフラグは、関数をアラート可能な状態で待機するスレッドで実行する必要がある場合に使用します。

I/O ワーカースレッドは Windows Vista および Windows Server 2008 以降で削除されました。

WT_EXECUTEINPERSISTENTTHREAD
0x00000080
コールバック関数は、終了することのないスレッドにキューイングされます。毎回同じスレッドが使用されることは保証されません。このフラグは短いタスクにのみ使用してください。そうでない場合、他のタイマー操作に影響を与える可能性があります。

スレッドが APC を使用する関数を呼び出す場合は、このフラグを設定する必要があります。詳細については、非同期プロシージャ呼び出しを参照してください。

保留中の I/O 要求がある場合はワーカースレッドは終了しませんが、現在のところ真に永続的なワーカースレッドは存在しないことに注意してください。

WT_EXECUTELONGFUNCTION
0x00000010
コールバック関数が長時間の待機を実行する可能性があります。このフラグは、新しいスレッドを作成すべきかどうかをシステムが判断するのに役立ちます。
WT_TRANSFER_IMPERSONATION
0x00000100
コールバック関数は、プロセストークンか偽装トークンかを問わず、現在のアクセストークンを使用します。このフラグが指定されていない場合、コールバック関数はプロセストークンのみで実行されます。

Windows XP: このフラグは Windows XP SP2 および Windows Server 2003 までサポートされていません。

戻り値の型: BOOL

公式ドキュメント

スレッドプール内のワーカースレッドに作業項目をキューイングします。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

DLL 内の関数がワーカースレッドにキューイングされている場合は、DLL がアンロードされる前にその関数の実行が完了していることを確認してください。

既定では、スレッドプールはプロセスごとに最大 512 スレッドを持ちます。キューの上限を引き上げるには、WinNT.h で定義されている WT_SET_MAX_THREADPOOL_THREAD マクロを使用します。

#define WT_SET_MAX_THREADPOOL_THREADS(Flags,Limit) \
    ((Flags)|=(Limit)<<16)

このマクロは QueueUserWorkItem の呼び出しで Flags パラメーターを指定するために使用します。マクロのパラメーターは、目的のフラグと新しい上限値であり、上限は (2<<16)-1 スレッドまでです。ただし、キューのサイズはカーネルの非ページプールのサイズによって制限されます。ワーカースレッドの数を低く抑えることで、アプリケーションのパフォーマンスを向上できることに注意してください。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0500 以降として定義します。詳細については、 Windows ヘッダーの使用を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL QueueUserWorkItem(
    LPTHREAD_START_ROUTINE Function,
    void* Context,   // optional
    WORKER_THREAD_FLAGS Flags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool QueueUserWorkItem(
    IntPtr Function,   // LPTHREAD_START_ROUTINE
    IntPtr Context,   // void* optional
    uint Flags   // WORKER_THREAD_FLAGS
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueueUserWorkItem(
    [Function] As IntPtr,   ' LPTHREAD_START_ROUTINE
    Context As IntPtr,   ' void* optional
    Flags As UInteger   ' WORKER_THREAD_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Function : LPTHREAD_START_ROUTINE
' Context : void* optional
' Flags : WORKER_THREAD_FLAGS
Declare PtrSafe Function QueueUserWorkItem Lib "kernel32" ( _
    ByVal Function As LongPtr, _
    ByVal Context As LongPtr, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

QueueUserWorkItem = ctypes.windll.kernel32.QueueUserWorkItem
QueueUserWorkItem.restype = wintypes.BOOL
QueueUserWorkItem.argtypes = [
    ctypes.c_void_p,  # Function : LPTHREAD_START_ROUTINE
    ctypes.POINTER(None),  # Context : void* optional
    wintypes.DWORD,  # Flags : WORKER_THREAD_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
QueueUserWorkItem = Fiddle::Function.new(
  lib['QueueUserWorkItem'],
  [
    Fiddle::TYPE_VOIDP,  # Function : LPTHREAD_START_ROUTINE
    Fiddle::TYPE_VOIDP,  # Context : void* optional
    -Fiddle::TYPE_INT,  # Flags : WORKER_THREAD_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn QueueUserWorkItem(
        Function: *const core::ffi::c_void,  // LPTHREAD_START_ROUTINE
        Context: *mut (),  // void* optional
        Flags: u32  // WORKER_THREAD_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool QueueUserWorkItem(IntPtr Function, IntPtr Context, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_QueueUserWorkItem' -Namespace Win32 -PassThru
# $api::QueueUserWorkItem(Function, Context, Flags)
#uselib "KERNEL32.dll"
#func global QueueUserWorkItem "QueueUserWorkItem" sptr, sptr, sptr
; QueueUserWorkItem Function, Context, Flags   ; 戻り値は stat
; Function : LPTHREAD_START_ROUTINE -> "sptr"
; Context : void* optional -> "sptr"
; Flags : WORKER_THREAD_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global QueueUserWorkItem "QueueUserWorkItem" sptr, sptr, int
; res = QueueUserWorkItem(Function, Context, Flags)
; Function : LPTHREAD_START_ROUTINE -> "sptr"
; Context : void* optional -> "sptr"
; Flags : WORKER_THREAD_FLAGS -> "int"
; BOOL QueueUserWorkItem(LPTHREAD_START_ROUTINE Function, void* Context, WORKER_THREAD_FLAGS Flags)
#uselib "KERNEL32.dll"
#cfunc global QueueUserWorkItem "QueueUserWorkItem" intptr, intptr, int
; res = QueueUserWorkItem(Function, Context, Flags)
; Function : LPTHREAD_START_ROUTINE -> "intptr"
; Context : void* optional -> "intptr"
; Flags : WORKER_THREAD_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procQueueUserWorkItem = kernel32.NewProc("QueueUserWorkItem")
)

// Function (LPTHREAD_START_ROUTINE), Context (void* optional), Flags (WORKER_THREAD_FLAGS)
r1, _, err := procQueueUserWorkItem.Call(
	uintptr(Function),
	uintptr(Context),
	uintptr(Flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function QueueUserWorkItem(
  Function: Pointer;   // LPTHREAD_START_ROUTINE
  Context: Pointer;   // void* optional
  Flags: DWORD   // WORKER_THREAD_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'QueueUserWorkItem';
result := DllCall("KERNEL32\QueueUserWorkItem"
    , "Ptr", Function   ; LPTHREAD_START_ROUTINE
    , "Ptr", Context   ; void* optional
    , "UInt", Flags   ; WORKER_THREAD_FLAGS
    , "Int")   ; return: BOOL
●QueueUserWorkItem(Function, Context, Flags) = DLL("KERNEL32.dll", "bool QueueUserWorkItem(void*, void*, dword)")
# 呼び出し: QueueUserWorkItem(Function, Context, Flags)
# Function : LPTHREAD_START_ROUTINE -> "void*"
# Context : void* optional -> "void*"
# Flags : WORKER_THREAD_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn QueueUserWorkItem(
    Function: ?*anyopaque, // LPTHREAD_START_ROUTINE
    Context: ?*anyopaque, // void* optional
    Flags: u32 // WORKER_THREAD_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc QueueUserWorkItem(
    Function: pointer,  # LPTHREAD_START_ROUTINE
    Context: pointer,  # void* optional
    Flags: uint32  # WORKER_THREAD_FLAGS
): int32 {.importc: "QueueUserWorkItem", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int QueueUserWorkItem(
    void* Function,   // LPTHREAD_START_ROUTINE
    void* Context,   // void* optional
    uint Flags   // WORKER_THREAD_FLAGS
);
ccall((:QueueUserWorkItem, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, UInt32),
      Function, Context, Flags)
# Function : LPTHREAD_START_ROUTINE -> Ptr{Cvoid}
# Context : void* optional -> Ptr{Cvoid}
# Flags : WORKER_THREAD_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t QueueUserWorkItem(
    void* Function,
    void* Context,
    uint32_t Flags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.QueueUserWorkItem(Function, Context, Flags)
-- Function : LPTHREAD_START_ROUTINE
-- Context : void* optional
-- Flags : WORKER_THREAD_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const QueueUserWorkItem = lib.func('__stdcall', 'QueueUserWorkItem', 'int32_t', ['void *', 'void *', 'uint32_t']);
// QueueUserWorkItem(Function, Context, Flags)
// Function : LPTHREAD_START_ROUTINE -> 'void *'
// Context : void* optional -> 'void *'
// Flags : WORKER_THREAD_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("KERNEL32.dll", {
  QueueUserWorkItem: { parameters: ["pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.QueueUserWorkItem(Function, Context, Flags)
// Function : LPTHREAD_START_ROUTINE -> "pointer"
// Context : void* optional -> "pointer"
// Flags : WORKER_THREAD_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t QueueUserWorkItem(
    void* Function,
    void* Context,
    uint32_t Flags);
C, "KERNEL32.dll");
// $ffi->QueueUserWorkItem(Function, Context, Flags);
// Function : LPTHREAD_START_ROUTINE
// Context : void* optional
// Flags : WORKER_THREAD_FLAGS
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean QueueUserWorkItem(
        Callback Function,   // LPTHREAD_START_ROUTINE
        Pointer Context,   // void* optional
        int Flags   // WORKER_THREAD_FLAGS
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun QueueUserWorkItem = QueueUserWorkItem(
    Function : Void*,   # LPTHREAD_START_ROUTINE
    Context : Void*,   # void* optional
    Flags : UInt32   # WORKER_THREAD_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef QueueUserWorkItemNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef QueueUserWorkItemDart = int Function(Pointer<Void>, Pointer<Void>, int);
final QueueUserWorkItem = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<QueueUserWorkItemNative, QueueUserWorkItemDart>('QueueUserWorkItem');
// Function : LPTHREAD_START_ROUTINE -> Pointer<Void>
// Context : void* optional -> Pointer<Void>
// Flags : WORKER_THREAD_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function QueueUserWorkItem(
  Function: Pointer;   // LPTHREAD_START_ROUTINE
  Context: Pointer;   // void* optional
  Flags: DWORD   // WORKER_THREAD_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'QueueUserWorkItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "QueueUserWorkItem"
  c_QueueUserWorkItem :: Ptr () -> Ptr () -> Word32 -> IO CInt
-- Function : LPTHREAD_START_ROUTINE -> Ptr ()
-- Context : void* optional -> Ptr ()
-- Flags : WORKER_THREAD_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let queueuserworkitem =
  foreign "QueueUserWorkItem"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* Function : LPTHREAD_START_ROUTINE -> (ptr void) *)
(* Context : void* optional -> (ptr void) *)
(* Flags : WORKER_THREAD_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("QueueUserWorkItem" queue-user-work-item :convention :stdcall) :int32
  (function :pointer)   ; LPTHREAD_START_ROUTINE
  (context :pointer)   ; void* optional
  (flags :uint32))   ; WORKER_THREAD_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $QueueUserWorkItem = Win32::API::More->new('KERNEL32',
    'BOOL QueueUserWorkItem(LPVOID Function, LPVOID Context, DWORD Flags)');
# my $ret = $QueueUserWorkItem->Call($Function, $Context, $Flags);
# Function : LPTHREAD_START_ROUTINE -> LPVOID
# Context : void* optional -> LPVOID
# Flags : WORKER_THREAD_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型