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

SetThreadAffinityMask

関数
スレッドのプロセッサアフィニティマスクを設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

UINT_PTR SetThreadAffinityMask(
    HANDLE hThread,
    UINT_PTR dwThreadAffinityMask
);

パラメーター

名前方向説明
hThreadHANDLEin

アフィニティマスクを設定するスレッドのハンドルです。

このハンドルには、THREAD_SET_INFORMATION または THREAD_SET_LIMITED_INFORMATION アクセス権と、THREAD_QUERY_INFORMATION または THREAD_QUERY_LIMITED_INFORMATION アクセス権が必要です。詳細については、 Thread Security and Access Rights を参照してください。

Windows Server 2003 および Windows XP: ハンドルには THREAD_SET_INFORMATION アクセス権と THREAD_QUERY_INFORMATION アクセス権が必要です。

dwThreadAffinityMaskUINT_PTRin

スレッドのアフィニティマスクです。

64 を超えるプロセッサを搭載したシステムでは、アフィニティマスクはスレッドの現在の プロセッサグループ 内のプロセッサを指定する必要があります。

戻り値の型: UINT_PTR

公式ドキュメント

指定したスレッドにプロセッサアフィニティマスクを設定します。

戻り値

関数が成功した場合、戻り値はスレッドの以前のアフィニティマスクです。

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

スレッドアフィニティマスクがプロセスアフィニティマスクで選択されていないプロセッサを要求した場合、最後のエラーコードは ERROR_INVALID_PARAMETER になります。

解説(Remarks)

スレッドアフィニティマスクはビットベクトルであり、各ビットはスレッドの実行が許可される論理プロセッサを表します。スレッドアフィニティマスクは、そのスレッドを含むプロセスのプロセスアフィニティマスクのサブセットでなければなりません。スレッドは、そのプロセスが実行可能なプロセッサ上でのみ実行できます。したがって、プロセスアフィニティマスクがあるプロセッサに対して 0 ビットを指定している場合、スレッドアフィニティマスクはそのプロセッサに対して 1 ビットを指定することはできません。

プロセスまたはスレッドにアフィニティマスクを設定すると、特定のプロセッサでのスレッド実行がシステムによって制限されるため、スレッドが受け取るプロセッサ時間が減少する可能性があります。多くの場合、利用可能なプロセッサをシステムに選択させる方が望ましいです。

新しいスレッドアフィニティマスクが現在スレッドを実行しているプロセッサを指定していない場合、スレッドは許可されたプロセッサのいずれかに再スケジュールされます。

Windows 11 および Windows Server 2022 以降では、64 を超えるプロセッサを搭載したシステムにおいて、プロセスおよびスレッドのアフィニティは既定ですべての プロセッサグループ にわたるシステム内の全プロセッサに及びます。dwThreadAffinityMask は、スレッドの現在のプライマリグループ内のプロセッサを指定する必要があります。

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

各言語での呼び出し定義

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

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

SetThreadAffinityMask = ctypes.windll.kernel32.SetThreadAffinityMask
SetThreadAffinityMask.restype = ctypes.c_size_t
SetThreadAffinityMask.argtypes = [
    wintypes.HANDLE,  # hThread : HANDLE
    ctypes.c_size_t,  # dwThreadAffinityMask : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetThreadAffinityMask = kernel32.NewProc("SetThreadAffinityMask")
)

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

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

typedef SetThreadAffinityMaskNative = UintPtr Function(Pointer<Void>, UintPtr);
typedef SetThreadAffinityMaskDart = int Function(Pointer<Void>, int);
final SetThreadAffinityMask = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetThreadAffinityMaskNative, SetThreadAffinityMaskDart>('SetThreadAffinityMask');
// hThread : HANDLE -> Pointer<Void>
// dwThreadAffinityMask : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetThreadAffinityMask(
  hThread: THandle;   // HANDLE
  dwThreadAffinityMask: NativeUInt   // UINT_PTR
): NativeUInt; stdcall;
  external 'KERNEL32.dll' name 'SetThreadAffinityMask';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetThreadAffinityMask"
  c_SetThreadAffinityMask :: Ptr () -> CUIntPtr -> IO CUIntPtr
-- hThread : HANDLE -> Ptr ()
-- dwThreadAffinityMask : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setthreadaffinitymask =
  foreign "SetThreadAffinityMask"
    ((ptr void) @-> size_t @-> returning size_t)
(* hThread : HANDLE -> (ptr void) *)
(* dwThreadAffinityMask : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetThreadAffinityMask" set-thread-affinity-mask :convention :stdcall) :uint64
  (h-thread :pointer)   ; HANDLE
  (dw-thread-affinity-mask :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetThreadAffinityMask = Win32::API::More->new('KERNEL32',
    'WPARAM SetThreadAffinityMask(HANDLE hThread, WPARAM dwThreadAffinityMask)');
# my $ret = $SetThreadAffinityMask->Call($hThread, $dwThreadAffinityMask);
# hThread : HANDLE -> HANDLE
# dwThreadAffinityMask : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目