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

SetThreadInformation

関数
指定スレッドの情報をクラス指定で設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

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

BOOL SetThreadInformation(
    HANDLE hThread,
    THREAD_INFORMATION_CLASS ThreadInformationClass,
    void* ThreadInformation,
    DWORD ThreadInformationSize
);

パラメーター

名前方向説明
hThreadHANDLEinスレッドのハンドル。このハンドルには THREAD_SET_INFORMATION アクセス権が必要です。詳細については、Thread Security and Access Rights を参照してください。
ThreadInformationClassTHREAD_INFORMATION_CLASSin設定する情報のクラス。サポートされている値は ThreadMemoryPriorityThreadPowerThrottling のみです。
ThreadInformationvoid*in

ThreadInformationClass パラメーターで指定された種類の情報を格納する構造体へのポインター。

ThreadInformationClass パラメーターが ThreadMemoryPriority の場合、このパラメーターは MEMORY_PRIORITY_INFORMATION 構造体を指している必要があります。

ThreadInformationClass パラメーターが ThreadPowerThrottling の場合、このパラメーターは THREAD_POWER_THROTTLING_STATE 構造体を指している必要があります。

ThreadInformationSizeDWORDin

ThreadInformation パラメーターで指定された構造体のサイズ (バイト単位)。

ThreadInformationClass パラメーターが ThreadMemoryPriority の場合、このパラメーターは sizeof(MEMORY_PRIORITY_INFORMATION) でなければなりません。

ThreadInformationClass パラメーターが ThreadPowerThrottling の場合、このパラメーターは sizeof(THREAD_POWER_THROTTLING_STATE) でなければなりません。

戻り値の型: BOOL

公式ドキュメント

指定したスレッドの情報を設定します。

戻り値

関数が成功した場合、戻り値は 0 以外です。

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

解説(Remarks)

システムのパフォーマンス向上に役立てるため、アプリケーションは SetThreadInformation 関数を ThreadMemoryPriority とともに使用して、バックグラウンド処理を行うスレッドや、すぐに再アクセスされる見込みのないファイルやデータにアクセスするスレッドのメモリ優先度を下げる必要があります。たとえば、マルウェア対策アプリケーションがファイルのスキャンに関与するスレッドの優先度を下げる、といった用途が考えられます。

メモリ優先度 は、ページがトリミングされるまでプロセスの ワーキングセット にとどまる時間を決定するのに役立ちます。スレッドのメモリ優先度は、そのスレッドによってプロセスのワーキングセットに追加される物理ページの最小優先度を決定します。メモリマネージャーがワーキングセットをトリミングする際は、優先度の高いページよりも優先度の低いページが先にトリミングされます。これにより、優先度の高いページはワーキングセットからトリミングされにくくなり、再アクセス時にページフォールトを引き起こす可能性が低くなるため、システム全体のパフォーマンスが向上します。

ThreadPowerThrottling はスレッドにスロットリングポリシーを有効化します。これは、最適なパフォーマンスが必要とされない場合に、パフォーマンスと電力効率のバランスを取るために使用できます。スレッドが THREAD_POWER_THROTTLING_EXECUTION_SPEED の有効化を選択すると、そのスレッドは EcoQoS に分類されます。システムは、CPU 周波数の低下や、より電力効率の高いコアの使用といった戦略を通じて、電力効率の向上を図ります。EcoQoS は、作業がフォアグラウンドのユーザーエクスペリエンスに寄与していない場合に使用すべきであり、バッテリー寿命の延長、発熱の低減、ファンノイズの低減をもたらします。EcoQoS は、パフォーマンスが重要な処理やフォアグラウンドのユーザーエクスペリエンスには使用すべきではありません。(Windows 11 より前では EcoQoS レベルは存在せず、代わりにプロセスは LowQoS としてラベル付けされていました。) アプリケーションが THREAD_POWER_THROTTLING_EXECUTION_SPEED を明示的に有効化しない場合、システムは独自のヒューリスティックを使用して Quality of Service レベルを自動的に推測します。詳細については、Quality of Service を参照してください。

Examples

次の例は、SetThreadInformationThreadMemoryPriority とともに呼び出して、現在のスレッドに低いメモリ優先度を設定する方法を示しています。

DWORD ErrorCode;
BOOL Success;
MEMORY_PRIORITY_INFORMATION MemPrio;

//
// Set low memory priority on the current thread.
//

ZeroMemory(&MemPrio, sizeof(MemPrio));
MemPrio.MemoryPriority = MEMORY_PRIORITY_LOW;

Success = SetThreadInformation(GetCurrentThread(),
                               ThreadMemoryPriority,
                               &MemPrio,
                               sizeof(MemPrio));

if (!Success) {
    ErrorCode = GetLastError();
    fprintf(stderr, "Set thread memory priority failed: %d\n", ErrorCode);
}

次の例は、SetThreadInformationThreadPowerThrottling とともに呼び出して、スレッドの Quality of Service を制御する方法を示しています。

THREAD_POWER_THROTTLING_STATE PowerThrottling;
ZeroMemory(&PowerThrottling, sizeof(PowerThrottling));
PowerThrottling.Version = THREAD_POWER_THROTTLING_CURRENT_VERSION;

//
// EcoQoS
// Turn EXECUTION_SPEED throttling on. 
// ControlMask selects the mechanism and StateMask declares which mechanism should be on or off.
//

PowerThrottling.ControlMask = THREAD_POWER_THROTTLING_EXECUTION_SPEED;
PowerThrottling.StateMask = THREAD_POWER_THROTTLING_EXECUTION_SPEED;

SetThreadInformation(GetCurrentThread(), 
                     ThreadPowerThrottling, 
                     &PowerThrottling, 
                     sizeof(PowerThrottling));

//
// HighQoS
// Turn EXECUTION_SPEED throttling off.
// ControlMask selects the mechanism and StateMask is set to zero as mechanisms should be turned off.
//

PowerThrottling.ControlMask = THREAD_POWER_THROTTLING_EXECUTION_SPEED;
PowerThrottling.StateMask = 0;

SetThreadInformation(GetCurrentThread(), 
                     ThreadPowerThrottling, 
                     &PowerThrottling, 
                     sizeof(PowerThrottling));

//
// Let system manage all power throttling. ControlMask is set to 0 as we don’t want 
// to control any mechanisms.
//

PowerThrottling.ControlMask = 0;
PowerThrottling.StateMask = 0;

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

各言語での呼び出し定義

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

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

SetThreadInformation = ctypes.windll.kernel32.SetThreadInformation
SetThreadInformation.restype = wintypes.BOOL
SetThreadInformation.argtypes = [
    wintypes.HANDLE,  # hThread : HANDLE
    ctypes.c_int,  # ThreadInformationClass : THREAD_INFORMATION_CLASS
    ctypes.POINTER(None),  # ThreadInformation : void*
    wintypes.DWORD,  # ThreadInformationSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadInformation = Fiddle::Function.new(
  lib['SetThreadInformation'],
  [
    Fiddle::TYPE_VOIDP,  # hThread : HANDLE
    Fiddle::TYPE_INT,  # ThreadInformationClass : THREAD_INFORMATION_CLASS
    Fiddle::TYPE_VOIDP,  # ThreadInformation : void*
    -Fiddle::TYPE_INT,  # ThreadInformationSize : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetThreadInformation(
        hThread: *mut core::ffi::c_void,  // HANDLE
        ThreadInformationClass: i32,  // THREAD_INFORMATION_CLASS
        ThreadInformation: *mut (),  // void*
        ThreadInformationSize: 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 SetThreadInformation(IntPtr hThread, int ThreadInformationClass, IntPtr ThreadInformation, uint ThreadInformationSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadInformation' -Namespace Win32 -PassThru
# $api::SetThreadInformation(hThread, ThreadInformationClass, ThreadInformation, ThreadInformationSize)
#uselib "KERNEL32.dll"
#func global SetThreadInformation "SetThreadInformation" sptr, sptr, sptr, sptr
; SetThreadInformation hThread, ThreadInformationClass, ThreadInformation, ThreadInformationSize   ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; ThreadInformationClass : THREAD_INFORMATION_CLASS -> "sptr"
; ThreadInformation : void* -> "sptr"
; ThreadInformationSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetThreadInformation "SetThreadInformation" sptr, int, sptr, int
; res = SetThreadInformation(hThread, ThreadInformationClass, ThreadInformation, ThreadInformationSize)
; hThread : HANDLE -> "sptr"
; ThreadInformationClass : THREAD_INFORMATION_CLASS -> "int"
; ThreadInformation : void* -> "sptr"
; ThreadInformationSize : DWORD -> "int"
; BOOL SetThreadInformation(HANDLE hThread, THREAD_INFORMATION_CLASS ThreadInformationClass, void* ThreadInformation, DWORD ThreadInformationSize)
#uselib "KERNEL32.dll"
#cfunc global SetThreadInformation "SetThreadInformation" intptr, int, intptr, int
; res = SetThreadInformation(hThread, ThreadInformationClass, ThreadInformation, ThreadInformationSize)
; hThread : HANDLE -> "intptr"
; ThreadInformationClass : THREAD_INFORMATION_CLASS -> "int"
; ThreadInformation : void* -> "intptr"
; ThreadInformationSize : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetThreadInformation = kernel32.NewProc("SetThreadInformation")
)

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

extern "kernel32" fn SetThreadInformation(
    hThread: ?*anyopaque, // HANDLE
    ThreadInformationClass: i32, // THREAD_INFORMATION_CLASS
    ThreadInformation: ?*anyopaque, // void*
    ThreadInformationSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SetThreadInformation(
    hThread: pointer,  # HANDLE
    ThreadInformationClass: int32,  # THREAD_INFORMATION_CLASS
    ThreadInformation: pointer,  # void*
    ThreadInformationSize: uint32  # DWORD
): int32 {.importc: "SetThreadInformation", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetThreadInformation(
    void* hThread,   // HANDLE
    int ThreadInformationClass,   // THREAD_INFORMATION_CLASS
    void* ThreadInformation,   // void*
    uint ThreadInformationSize   // DWORD
);
ccall((:SetThreadInformation, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}, UInt32),
      hThread, ThreadInformationClass, ThreadInformation, ThreadInformationSize)
# hThread : HANDLE -> Ptr{Cvoid}
# ThreadInformationClass : THREAD_INFORMATION_CLASS -> Int32
# ThreadInformation : void* -> Ptr{Cvoid}
# ThreadInformationSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetThreadInformation(
    void* hThread,
    int32_t ThreadInformationClass,
    void* ThreadInformation,
    uint32_t ThreadInformationSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetThreadInformation(hThread, ThreadInformationClass, ThreadInformation, ThreadInformationSize)
-- hThread : HANDLE
-- ThreadInformationClass : THREAD_INFORMATION_CLASS
-- ThreadInformation : void*
-- ThreadInformationSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetThreadInformation = lib.func('__stdcall', 'SetThreadInformation', 'int32_t', ['void *', 'int32_t', 'void *', 'uint32_t']);
// SetThreadInformation(hThread, ThreadInformationClass, ThreadInformation, ThreadInformationSize)
// hThread : HANDLE -> 'void *'
// ThreadInformationClass : THREAD_INFORMATION_CLASS -> 'int32_t'
// ThreadInformation : void* -> 'void *'
// ThreadInformationSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetThreadInformation: { parameters: ["pointer", "i32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SetThreadInformation(hThread, ThreadInformationClass, ThreadInformation, ThreadInformationSize)
// hThread : HANDLE -> "pointer"
// ThreadInformationClass : THREAD_INFORMATION_CLASS -> "i32"
// ThreadInformation : void* -> "pointer"
// ThreadInformationSize : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetThreadInformation(
    void* hThread,
    int32_t ThreadInformationClass,
    void* ThreadInformation,
    uint32_t ThreadInformationSize);
C, "KERNEL32.dll");
// $ffi->SetThreadInformation(hThread, ThreadInformationClass, ThreadInformation, ThreadInformationSize);
// hThread : HANDLE
// ThreadInformationClass : THREAD_INFORMATION_CLASS
// ThreadInformation : void*
// ThreadInformationSize : 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 SetThreadInformation(
        Pointer hThread,   // HANDLE
        int ThreadInformationClass,   // THREAD_INFORMATION_CLASS
        Pointer ThreadInformation,   // void*
        int ThreadInformationSize   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetThreadInformation = SetThreadInformation(
    hThread : Void*,   # HANDLE
    ThreadInformationClass : Int32,   # THREAD_INFORMATION_CLASS
    ThreadInformation : Void*,   # void*
    ThreadInformationSize : 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 SetThreadInformationNative = Int32 Function(Pointer<Void>, Int32, Pointer<Void>, Uint32);
typedef SetThreadInformationDart = int Function(Pointer<Void>, int, Pointer<Void>, int);
final SetThreadInformation = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetThreadInformationNative, SetThreadInformationDart>('SetThreadInformation');
// hThread : HANDLE -> Pointer<Void>
// ThreadInformationClass : THREAD_INFORMATION_CLASS -> Int32
// ThreadInformation : void* -> Pointer<Void>
// ThreadInformationSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetThreadInformation(
  hThread: THandle;   // HANDLE
  ThreadInformationClass: Integer;   // THREAD_INFORMATION_CLASS
  ThreadInformation: Pointer;   // void*
  ThreadInformationSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetThreadInformation';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetThreadInformation"
  c_SetThreadInformation :: Ptr () -> Int32 -> Ptr () -> Word32 -> IO CInt
-- hThread : HANDLE -> Ptr ()
-- ThreadInformationClass : THREAD_INFORMATION_CLASS -> Int32
-- ThreadInformation : void* -> Ptr ()
-- ThreadInformationSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setthreadinformation =
  foreign "SetThreadInformation"
    ((ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hThread : HANDLE -> (ptr void) *)
(* ThreadInformationClass : THREAD_INFORMATION_CLASS -> int32_t *)
(* ThreadInformation : void* -> (ptr void) *)
(* ThreadInformationSize : 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 ("SetThreadInformation" set-thread-information :convention :stdcall) :int32
  (h-thread :pointer)   ; HANDLE
  (thread-information-class :int32)   ; THREAD_INFORMATION_CLASS
  (thread-information :pointer)   ; void*
  (thread-information-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetThreadInformation = Win32::API::More->new('KERNEL32',
    'BOOL SetThreadInformation(HANDLE hThread, int ThreadInformationClass, LPVOID ThreadInformation, DWORD ThreadInformationSize)');
# my $ret = $SetThreadInformation->Call($hThread, $ThreadInformationClass, $ThreadInformation, $ThreadInformationSize);
# hThread : HANDLE -> HANDLE
# ThreadInformationClass : THREAD_INFORMATION_CLASS -> int
# ThreadInformation : void* -> LPVOID
# ThreadInformationSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型