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

SetThreadpoolThreadMinimum

関数
スレッドプールの最小スレッド数を設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL SetThreadpoolThreadMinimum(
    PTP_POOL ptpp,
    DWORD cthrdMic
);

パラメーター

名前方向説明
ptppPTP_POOLinスレッドプールを定義する TP_POOL 構造体へのポインターです。このポインターは CreateThreadpool 関数が返します。
cthrdMicDWORDinスレッドの最小数です。

戻り値の型: BOOL

公式ドキュメント

指定したスレッドプールがコールバックを処理するために利用可能にしておくべきスレッドの最小数を設定します。

戻り値

関数が成功した場合は TRUE を返します。

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

解説(Remarks)

プールが割り当て可能なスレッドの最大数を指定するには、SetThreadpoolThreadMaximum を呼び出します。

この関数を使用するアプリケーションをコンパイルするには、_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>

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

SetThreadpoolThreadMinimum = ctypes.windll.kernel32.SetThreadpoolThreadMinimum
SetThreadpoolThreadMinimum.restype = wintypes.BOOL
SetThreadpoolThreadMinimum.argtypes = [
    ctypes.c_ssize_t,  # ptpp : PTP_POOL
    wintypes.DWORD,  # cthrdMic : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadpoolThreadMinimum = Fiddle::Function.new(
  lib['SetThreadpoolThreadMinimum'],
  [
    Fiddle::TYPE_INTPTR_T,  # ptpp : PTP_POOL
    -Fiddle::TYPE_INT,  # cthrdMic : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetThreadpoolThreadMinimum(
        ptpp: isize,  // PTP_POOL
        cthrdMic: u32  // DWORD
    ) -> 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 SetThreadpoolThreadMinimum(IntPtr ptpp, uint cthrdMic);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadpoolThreadMinimum' -Namespace Win32 -PassThru
# $api::SetThreadpoolThreadMinimum(ptpp, cthrdMic)
#uselib "KERNEL32.dll"
#func global SetThreadpoolThreadMinimum "SetThreadpoolThreadMinimum" sptr, sptr
; SetThreadpoolThreadMinimum ptpp, cthrdMic   ; 戻り値は stat
; ptpp : PTP_POOL -> "sptr"
; cthrdMic : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetThreadpoolThreadMinimum "SetThreadpoolThreadMinimum" sptr, int
; res = SetThreadpoolThreadMinimum(ptpp, cthrdMic)
; ptpp : PTP_POOL -> "sptr"
; cthrdMic : DWORD -> "int"
; BOOL SetThreadpoolThreadMinimum(PTP_POOL ptpp, DWORD cthrdMic)
#uselib "KERNEL32.dll"
#cfunc global SetThreadpoolThreadMinimum "SetThreadpoolThreadMinimum" intptr, int
; res = SetThreadpoolThreadMinimum(ptpp, cthrdMic)
; ptpp : PTP_POOL -> "intptr"
; cthrdMic : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetThreadpoolThreadMinimum = kernel32.NewProc("SetThreadpoolThreadMinimum")
)

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

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

typedef SetThreadpoolThreadMinimumNative = Int32 Function(IntPtr, Uint32);
typedef SetThreadpoolThreadMinimumDart = int Function(int, int);
final SetThreadpoolThreadMinimum = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetThreadpoolThreadMinimumNative, SetThreadpoolThreadMinimumDart>('SetThreadpoolThreadMinimum');
// ptpp : PTP_POOL -> IntPtr
// cthrdMic : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetThreadpoolThreadMinimum(
  ptpp: NativeInt;   // PTP_POOL
  cthrdMic: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetThreadpoolThreadMinimum';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetThreadpoolThreadMinimum"
  c_SetThreadpoolThreadMinimum :: CIntPtr -> Word32 -> IO CInt
-- ptpp : PTP_POOL -> CIntPtr
-- cthrdMic : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setthreadpoolthreadminimum =
  foreign "SetThreadpoolThreadMinimum"
    (intptr_t @-> uint32_t @-> returning int32_t)
(* ptpp : PTP_POOL -> intptr_t *)
(* cthrdMic : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetThreadpoolThreadMinimum" set-threadpool-thread-minimum :convention :stdcall) :int32
  (ptpp :int64)   ; PTP_POOL
  (cthrd-mic :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetThreadpoolThreadMinimum = Win32::API::More->new('KERNEL32',
    'BOOL SetThreadpoolThreadMinimum(LPARAM ptpp, DWORD cthrdMic)');
# my $ret = $SetThreadpoolThreadMinimum->Call($ptpp, $cthrdMic);
# ptpp : PTP_POOL -> LPARAM
# cthrdMic : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目