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

GetThreadGroupAffinity

関数
スレッドのグループアフィニティを取得する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

BOOL GetThreadGroupAffinity(
    HANDLE hThread,
    GROUP_AFFINITY* GroupAffinity
);

パラメーター

名前方向説明
hThreadHANDLEin

プロセッサグループアフィニティを取得する対象スレッドのハンドル。

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

GroupAffinityGROUP_AFFINITY*outスレッドのグループアフィニティを受け取る GROUP_AFFINITY 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定したスレッドのプロセッサグループアフィニティを取得します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を使用してください。

解説(Remarks)

Windows 11 および Windows Server 2022 以降では、64 を超えるプロセッサを搭載したシステムにおいて、プロセスおよびスレッドのアフィニティは既定ですべてのプロセッサグループにまたがり、システム内のすべてのプロセッサを対象とします。GetThreadGroupAffinity 関数は、スレッドのプライマリグループに対するグループアフィニティを取得します。

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

各言語での呼び出し定義

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

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

GetThreadGroupAffinity = ctypes.windll.kernel32.GetThreadGroupAffinity
GetThreadGroupAffinity.restype = wintypes.BOOL
GetThreadGroupAffinity.argtypes = [
    wintypes.HANDLE,  # hThread : HANDLE
    ctypes.c_void_p,  # GroupAffinity : GROUP_AFFINITY* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetThreadGroupAffinity = Fiddle::Function.new(
  lib['GetThreadGroupAffinity'],
  [
    Fiddle::TYPE_VOIDP,  # hThread : HANDLE
    Fiddle::TYPE_VOIDP,  # GroupAffinity : GROUP_AFFINITY* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetThreadGroupAffinity(
        hThread: *mut core::ffi::c_void,  // HANDLE
        GroupAffinity: *mut GROUP_AFFINITY  // GROUP_AFFINITY* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool GetThreadGroupAffinity(IntPtr hThread, IntPtr GroupAffinity);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetThreadGroupAffinity' -Namespace Win32 -PassThru
# $api::GetThreadGroupAffinity(hThread, GroupAffinity)
#uselib "KERNEL32.dll"
#func global GetThreadGroupAffinity "GetThreadGroupAffinity" sptr, sptr
; GetThreadGroupAffinity hThread, varptr(GroupAffinity)   ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; GroupAffinity : GROUP_AFFINITY* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetThreadGroupAffinity "GetThreadGroupAffinity" sptr, var
; res = GetThreadGroupAffinity(hThread, GroupAffinity)
; hThread : HANDLE -> "sptr"
; GroupAffinity : GROUP_AFFINITY* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetThreadGroupAffinity(HANDLE hThread, GROUP_AFFINITY* GroupAffinity)
#uselib "KERNEL32.dll"
#cfunc global GetThreadGroupAffinity "GetThreadGroupAffinity" intptr, var
; res = GetThreadGroupAffinity(hThread, GroupAffinity)
; hThread : HANDLE -> "intptr"
; GroupAffinity : GROUP_AFFINITY* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetThreadGroupAffinity = kernel32.NewProc("GetThreadGroupAffinity")
)

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

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

typedef GetThreadGroupAffinityNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef GetThreadGroupAffinityDart = int Function(Pointer<Void>, Pointer<Void>);
final GetThreadGroupAffinity = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetThreadGroupAffinityNative, GetThreadGroupAffinityDart>('GetThreadGroupAffinity');
// hThread : HANDLE -> Pointer<Void>
// GroupAffinity : GROUP_AFFINITY* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetThreadGroupAffinity(
  hThread: THandle;   // HANDLE
  GroupAffinity: Pointer   // GROUP_AFFINITY* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetThreadGroupAffinity';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetThreadGroupAffinity"
  c_GetThreadGroupAffinity :: Ptr () -> Ptr () -> IO CInt
-- hThread : HANDLE -> Ptr ()
-- GroupAffinity : GROUP_AFFINITY* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getthreadgroupaffinity =
  foreign "GetThreadGroupAffinity"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hThread : HANDLE -> (ptr void) *)
(* GroupAffinity : GROUP_AFFINITY* 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 ("GetThreadGroupAffinity" get-thread-group-affinity :convention :stdcall) :int32
  (h-thread :pointer)   ; HANDLE
  (group-affinity :pointer))   ; GROUP_AFFINITY* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetThreadGroupAffinity = Win32::API::More->new('KERNEL32',
    'BOOL GetThreadGroupAffinity(HANDLE hThread, LPVOID GroupAffinity)');
# my $ret = $GetThreadGroupAffinity->Call($hThread, $GroupAffinity);
# hThread : HANDLE -> HANDLE
# GroupAffinity : GROUP_AFFINITY* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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