ホーム › System.Threading › SetThreadGroupAffinity
SetThreadGroupAffinity
関数スレッドのグループアフィニティを設定する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL SetThreadGroupAffinity(
HANDLE hThread,
const GROUP_AFFINITY* GroupAffinity,
GROUP_AFFINITY* PreviousGroupAffinity // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hThread | HANDLE | in | スレッドへのハンドル。 このハンドルには THREAD_SET_INFORMATION アクセス権が必要です。詳細については、 Thread Security and Access Rights を参照してください。 |
| GroupAffinity | GROUP_AFFINITY* | in | 指定したスレッドに使用するプロセッサグループアフィニティを指定する GROUP_AFFINITY 構造体です。 |
| PreviousGroupAffinity | GROUP_AFFINITY* | outoptional | スレッドの以前のグループアフィニティを受け取る GROUP_AFFINITY 構造体へのポインター。このパラメーターは NULL でもかまいません。 |
戻り値の型: BOOL
公式ドキュメント
指定したスレッドのプロセッサグループアフィニティを設定します。
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を使用します。
解説(Remarks)
Windows 11 および Windows Server 2022 以降では、64 個を超えるプロセッサを搭載したシステムにおいて、プロセスおよびスレッドのアフィニティは既定ですべての processor groups にわたってシステム内のすべてのプロセッサに及びます。 SetThreadGroupAffinity 関数は、指定された GroupAffinity で指定された単一のプロセッサグループ内のプロセッサにスレッドのアフィニティを制限します。このグループは、そのスレッドのプライマリグループにもなります。
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT >= 0x0601 を設定します。詳細については、Using the Windows Headers を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL SetThreadGroupAffinity(
HANDLE hThread,
const GROUP_AFFINITY* GroupAffinity,
GROUP_AFFINITY* PreviousGroupAffinity // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool SetThreadGroupAffinity(
IntPtr hThread, // HANDLE
IntPtr GroupAffinity, // GROUP_AFFINITY*
IntPtr PreviousGroupAffinity // GROUP_AFFINITY* optional, out
);<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function SetThreadGroupAffinity(
hThread As IntPtr, ' HANDLE
GroupAffinity As IntPtr, ' GROUP_AFFINITY*
PreviousGroupAffinity As IntPtr ' GROUP_AFFINITY* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hThread : HANDLE
' GroupAffinity : GROUP_AFFINITY*
' PreviousGroupAffinity : GROUP_AFFINITY* optional, out
Declare PtrSafe Function SetThreadGroupAffinity Lib "kernel32" ( _
ByVal hThread As LongPtr, _
ByVal GroupAffinity As LongPtr, _
ByVal PreviousGroupAffinity As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetThreadGroupAffinity = ctypes.windll.kernel32.SetThreadGroupAffinity
SetThreadGroupAffinity.restype = wintypes.BOOL
SetThreadGroupAffinity.argtypes = [
wintypes.HANDLE, # hThread : HANDLE
ctypes.c_void_p, # GroupAffinity : GROUP_AFFINITY*
ctypes.c_void_p, # PreviousGroupAffinity : GROUP_AFFINITY* optional, out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadGroupAffinity = Fiddle::Function.new(
lib['SetThreadGroupAffinity'],
[
Fiddle::TYPE_VOIDP, # hThread : HANDLE
Fiddle::TYPE_VOIDP, # GroupAffinity : GROUP_AFFINITY*
Fiddle::TYPE_VOIDP, # PreviousGroupAffinity : GROUP_AFFINITY* optional, out
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn SetThreadGroupAffinity(
hThread: *mut core::ffi::c_void, // HANDLE
GroupAffinity: *const GROUP_AFFINITY, // GROUP_AFFINITY*
PreviousGroupAffinity: *mut GROUP_AFFINITY // GROUP_AFFINITY* optional, out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool SetThreadGroupAffinity(IntPtr hThread, IntPtr GroupAffinity, IntPtr PreviousGroupAffinity);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadGroupAffinity' -Namespace Win32 -PassThru
# $api::SetThreadGroupAffinity(hThread, GroupAffinity, PreviousGroupAffinity)#uselib "KERNEL32.dll"
#func global SetThreadGroupAffinity "SetThreadGroupAffinity" sptr, sptr, sptr
; SetThreadGroupAffinity hThread, varptr(GroupAffinity), varptr(PreviousGroupAffinity) ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; GroupAffinity : GROUP_AFFINITY* -> "sptr"
; PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global SetThreadGroupAffinity "SetThreadGroupAffinity" sptr, var, var ; res = SetThreadGroupAffinity(hThread, GroupAffinity, PreviousGroupAffinity) ; hThread : HANDLE -> "sptr" ; GroupAffinity : GROUP_AFFINITY* -> "var" ; PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global SetThreadGroupAffinity "SetThreadGroupAffinity" sptr, sptr, sptr ; res = SetThreadGroupAffinity(hThread, varptr(GroupAffinity), varptr(PreviousGroupAffinity)) ; hThread : HANDLE -> "sptr" ; GroupAffinity : GROUP_AFFINITY* -> "sptr" ; PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL SetThreadGroupAffinity(HANDLE hThread, GROUP_AFFINITY* GroupAffinity, GROUP_AFFINITY* PreviousGroupAffinity) #uselib "KERNEL32.dll" #cfunc global SetThreadGroupAffinity "SetThreadGroupAffinity" intptr, var, var ; res = SetThreadGroupAffinity(hThread, GroupAffinity, PreviousGroupAffinity) ; hThread : HANDLE -> "intptr" ; GroupAffinity : GROUP_AFFINITY* -> "var" ; PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SetThreadGroupAffinity(HANDLE hThread, GROUP_AFFINITY* GroupAffinity, GROUP_AFFINITY* PreviousGroupAffinity) #uselib "KERNEL32.dll" #cfunc global SetThreadGroupAffinity "SetThreadGroupAffinity" intptr, intptr, intptr ; res = SetThreadGroupAffinity(hThread, varptr(GroupAffinity), varptr(PreviousGroupAffinity)) ; hThread : HANDLE -> "intptr" ; GroupAffinity : GROUP_AFFINITY* -> "intptr" ; PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSetThreadGroupAffinity = kernel32.NewProc("SetThreadGroupAffinity")
)
// hThread (HANDLE), GroupAffinity (GROUP_AFFINITY*), PreviousGroupAffinity (GROUP_AFFINITY* optional, out)
r1, _, err := procSetThreadGroupAffinity.Call(
uintptr(hThread),
uintptr(GroupAffinity),
uintptr(PreviousGroupAffinity),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetThreadGroupAffinity(
hThread: THandle; // HANDLE
GroupAffinity: Pointer; // GROUP_AFFINITY*
PreviousGroupAffinity: Pointer // GROUP_AFFINITY* optional, out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetThreadGroupAffinity';result := DllCall("KERNEL32\SetThreadGroupAffinity"
, "Ptr", hThread ; HANDLE
, "Ptr", GroupAffinity ; GROUP_AFFINITY*
, "Ptr", PreviousGroupAffinity ; GROUP_AFFINITY* optional, out
, "Int") ; return: BOOL●SetThreadGroupAffinity(hThread, GroupAffinity, PreviousGroupAffinity) = DLL("KERNEL32.dll", "bool SetThreadGroupAffinity(void*, void*, void*)")
# 呼び出し: SetThreadGroupAffinity(hThread, GroupAffinity, PreviousGroupAffinity)
# hThread : HANDLE -> "void*"
# GroupAffinity : GROUP_AFFINITY* -> "void*"
# PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn SetThreadGroupAffinity(
hThread: ?*anyopaque, // HANDLE
GroupAffinity: [*c]GROUP_AFFINITY, // GROUP_AFFINITY*
PreviousGroupAffinity: [*c]GROUP_AFFINITY // GROUP_AFFINITY* optional, out
) callconv(std.os.windows.WINAPI) i32;proc SetThreadGroupAffinity(
hThread: pointer, # HANDLE
GroupAffinity: ptr GROUP_AFFINITY, # GROUP_AFFINITY*
PreviousGroupAffinity: ptr GROUP_AFFINITY # GROUP_AFFINITY* optional, out
): int32 {.importc: "SetThreadGroupAffinity", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int SetThreadGroupAffinity(
void* hThread, // HANDLE
GROUP_AFFINITY* GroupAffinity, // GROUP_AFFINITY*
GROUP_AFFINITY* PreviousGroupAffinity // GROUP_AFFINITY* optional, out
);ccall((:SetThreadGroupAffinity, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{GROUP_AFFINITY}, Ptr{GROUP_AFFINITY}),
hThread, GroupAffinity, PreviousGroupAffinity)
# hThread : HANDLE -> Ptr{Cvoid}
# GroupAffinity : GROUP_AFFINITY* -> Ptr{GROUP_AFFINITY}
# PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> Ptr{GROUP_AFFINITY}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SetThreadGroupAffinity(
void* hThread,
void* GroupAffinity,
void* PreviousGroupAffinity);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetThreadGroupAffinity(hThread, GroupAffinity, PreviousGroupAffinity)
-- hThread : HANDLE
-- GroupAffinity : GROUP_AFFINITY*
-- PreviousGroupAffinity : GROUP_AFFINITY* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetThreadGroupAffinity = lib.func('__stdcall', 'SetThreadGroupAffinity', 'int32_t', ['void *', 'void *', 'void *']);
// SetThreadGroupAffinity(hThread, GroupAffinity, PreviousGroupAffinity)
// hThread : HANDLE -> 'void *'
// GroupAffinity : GROUP_AFFINITY* -> 'void *'
// PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SetThreadGroupAffinity: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SetThreadGroupAffinity(hThread, GroupAffinity, PreviousGroupAffinity)
// hThread : HANDLE -> "pointer"
// GroupAffinity : GROUP_AFFINITY* -> "pointer"
// PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetThreadGroupAffinity(
void* hThread,
void* GroupAffinity,
void* PreviousGroupAffinity);
C, "KERNEL32.dll");
// $ffi->SetThreadGroupAffinity(hThread, GroupAffinity, PreviousGroupAffinity);
// hThread : HANDLE
// GroupAffinity : GROUP_AFFINITY*
// PreviousGroupAffinity : GROUP_AFFINITY* optional, out
// 構造体/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 SetThreadGroupAffinity(
Pointer hThread, // HANDLE
Pointer GroupAffinity, // GROUP_AFFINITY*
Pointer PreviousGroupAffinity // GROUP_AFFINITY* optional, out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun SetThreadGroupAffinity = SetThreadGroupAffinity(
hThread : Void*, # HANDLE
GroupAffinity : GROUP_AFFINITY*, # GROUP_AFFINITY*
PreviousGroupAffinity : GROUP_AFFINITY* # GROUP_AFFINITY* optional, out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetThreadGroupAffinityNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef SetThreadGroupAffinityDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final SetThreadGroupAffinity = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SetThreadGroupAffinityNative, SetThreadGroupAffinityDart>('SetThreadGroupAffinity');
// hThread : HANDLE -> Pointer<Void>
// GroupAffinity : GROUP_AFFINITY* -> Pointer<Void>
// PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetThreadGroupAffinity(
hThread: THandle; // HANDLE
GroupAffinity: Pointer; // GROUP_AFFINITY*
PreviousGroupAffinity: Pointer // GROUP_AFFINITY* optional, out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetThreadGroupAffinity';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetThreadGroupAffinity"
c_SetThreadGroupAffinity :: Ptr () -> Ptr () -> Ptr () -> IO CInt
-- hThread : HANDLE -> Ptr ()
-- GroupAffinity : GROUP_AFFINITY* -> Ptr ()
-- PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setthreadgroupaffinity =
foreign "SetThreadGroupAffinity"
((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hThread : HANDLE -> (ptr void) *)
(* GroupAffinity : GROUP_AFFINITY* -> (ptr void) *)
(* PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("SetThreadGroupAffinity" set-thread-group-affinity :convention :stdcall) :int32
(h-thread :pointer) ; HANDLE
(group-affinity :pointer) ; GROUP_AFFINITY*
(previous-group-affinity :pointer)) ; GROUP_AFFINITY* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetThreadGroupAffinity = Win32::API::More->new('KERNEL32',
'BOOL SetThreadGroupAffinity(HANDLE hThread, LPVOID GroupAffinity, LPVOID PreviousGroupAffinity)');
# my $ret = $SetThreadGroupAffinity->Call($hThread, $GroupAffinity, $PreviousGroupAffinity);
# hThread : HANDLE -> HANDLE
# GroupAffinity : GROUP_AFFINITY* -> LPVOID
# PreviousGroupAffinity : GROUP_AFFINITY* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
使用する型