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

CreateThreadpool

関数
新しいスレッドプールを作成する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

PTP_POOL CreateThreadpool(
    void* reserved   // optional
);

パラメーター

名前方向説明
reservedvoid*optionalこのパラメーターは予約されており、NULL を指定する必要があります。

戻り値の型: PTP_POOL

公式ドキュメント

コールバックを実行するためのスレッドプールを新たに割り当てます。

戻り値

関数が成功した場合、新たに割り当てられたスレッドプールを表す TP_POOL 構造体へのポインターを返します。アプリケーションはこの構造体のメンバーを変更しないでください。

関数が失敗した場合は NULL を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

新しいスレッドプールを作成したら、SetThreadpoolThreadMaximum を呼び出してプールが割り当て可能なスレッドの最大数を指定し、SetThreadpoolThreadMinimum を呼び出してプール内で利用可能なスレッドの最小数を指定してください。

プールを使用するには、プールをコールバック環境に関連付ける必要があります。コールバック環境を作成するには、InitializeThreadpoolEnvironment を呼び出します。次に、SetThreadpoolCallbackPool を呼び出して、プールをコールバック環境に関連付けます。

スレッドプールを解放するには、CloseThreadpool を呼び出します。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以上として定義します。

例については、スレッドプール関数の使用を参照してください。

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

各言語での呼び出し定義

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

PTP_POOL CreateThreadpool(
    void* reserved   // optional
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateThreadpool(
    IntPtr reserved   // void* optional
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateThreadpool(
    reserved As IntPtr   ' void* optional
) As IntPtr
End Function
' reserved : void* optional
Declare PtrSafe Function CreateThreadpool Lib "kernel32" ( _
    ByVal reserved As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateThreadpool = ctypes.windll.kernel32.CreateThreadpool
CreateThreadpool.restype = ctypes.c_ssize_t
CreateThreadpool.argtypes = [
    ctypes.POINTER(None),  # reserved : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateThreadpool = Fiddle::Function.new(
  lib['CreateThreadpool'],
  [
    Fiddle::TYPE_VOIDP,  # reserved : void* optional
  ],
  Fiddle::TYPE_INTPTR_T)
#[link(name = "kernel32")]
extern "system" {
    fn CreateThreadpool(
        reserved: *mut ()  // void* optional
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern IntPtr CreateThreadpool(IntPtr reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateThreadpool' -Namespace Win32 -PassThru
# $api::CreateThreadpool(reserved)
#uselib "KERNEL32.dll"
#func global CreateThreadpool "CreateThreadpool" sptr
; CreateThreadpool reserved   ; 戻り値は stat
; reserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global CreateThreadpool "CreateThreadpool" sptr
; res = CreateThreadpool(reserved)
; reserved : void* optional -> "sptr"
; PTP_POOL CreateThreadpool(void* reserved)
#uselib "KERNEL32.dll"
#cfunc global CreateThreadpool "CreateThreadpool" intptr
; res = CreateThreadpool(reserved)
; reserved : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateThreadpool = kernel32.NewProc("CreateThreadpool")
)

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

extern "kernel32" fn CreateThreadpool(
    reserved: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) isize;
proc CreateThreadpool(
    reserved: pointer  # void* optional
): int {.importc: "CreateThreadpool", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
ptrdiff_t CreateThreadpool(
    void* reserved   // void* optional
);
ccall((:CreateThreadpool, "KERNEL32.dll"), stdcall, Int,
      (Ptr{Cvoid},),
      reserved)
# reserved : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
intptr_t CreateThreadpool(
    void* reserved);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreateThreadpool(reserved)
-- reserved : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CreateThreadpool = lib.func('__stdcall', 'CreateThreadpool', 'intptr_t', ['void *']);
// CreateThreadpool(reserved)
// reserved : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CreateThreadpool: { parameters: ["pointer"], result: "isize" },
});
// lib.symbols.CreateThreadpool(reserved)
// reserved : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
intptr_t CreateThreadpool(
    void* reserved);
C, "KERNEL32.dll");
// $ffi->CreateThreadpool(reserved);
// reserved : void* optional
// 構造体/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);
    long CreateThreadpool(
        Pointer reserved   // void* optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun CreateThreadpool = CreateThreadpool(
    reserved : Void*   # void* optional
  ) : LibC::SSizeT
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CreateThreadpoolNative = IntPtr Function(Pointer<Void>);
typedef CreateThreadpoolDart = int Function(Pointer<Void>);
final CreateThreadpool = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateThreadpoolNative, CreateThreadpoolDart>('CreateThreadpool');
// reserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateThreadpool(
  reserved: Pointer   // void* optional
): NativeInt; stdcall;
  external 'KERNEL32.dll' name 'CreateThreadpool';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateThreadpool"
  c_CreateThreadpool :: Ptr () -> IO CIntPtr
-- reserved : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createthreadpool =
  foreign "CreateThreadpool"
    ((ptr void) @-> returning intptr_t)
(* reserved : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateThreadpool" create-threadpool :convention :stdcall) :int64
  (reserved :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateThreadpool = Win32::API::More->new('KERNEL32',
    'LPARAM CreateThreadpool(LPVOID reserved)');
# my $ret = $CreateThreadpool->Call($reserved);
# reserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目