ホーム › System.Threading › GetThreadSelectedCpuSetMasks

GetThreadSelectedCpuSetMasks

関数

スレッドに選択されたCPUセットマスクを取得する。

DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL GetThreadSelectedCpuSetMasks(
    HANDLE Thread,
    GROUP_AFFINITY* CpuSetMasks,   // optional
    WORD CpuSetMaskCount,
    WORD* RequiredMaskCount
);

パラメーター

名前	型	方向	説明
Thread	HANDLE	in	選択された CPU Set を照会する対象のスレッドを指定します。このハンドルには PROCESS_QUERY_LIMITED_INFORMATION アクセス権が必要です。GetCurrentProcess が返す値もここに指定できます。
CpuSetMasks	GROUP_AFFINITY*	outoptional	スレッドの選択された CPU Set を表す GROUP_AFFINITY 構造体のリストを取得するための、省略可能なバッファーを指定します。
CpuSetMaskCount	WORD	in	CpuSetMasks 配列のサイズを要素数で指定します。
RequiredMaskCount	WORD*	out	正常に返された場合、配列に書き込まれたアフィニティ構造体の数を指定します。配列が小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFER で失敗し、RequiredMaskCount パラメーターに必要な要素数を設定します。必要な要素数は、常に GetMaximumProcessorGroupCount が返す最大グループ数以下です。

戻り値の型: BOOL

公式ドキュメント

指定したスレッドの明示的な CPU Set 割り当てを返します(SetThreadSelectedCpuSetMasks または SetThreadSelectedCpuSets で割り当てが設定されている場合)。

戻り値

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

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

指定した配列が小さすぎる場合、エラー値は ERROR_INSUFFICIENT_BUFFER となり、RequiredMaskCount に必要な要素数が設定されます。

解説(Remarks)

明示的な割り当てが設定されていない場合、RequiredMaskCount は 0 に設定され、関数は成功します。

この関数は GetThreadSelectedCpuSets に類似していますが、CPU Set ID ではなくグループアフィニティを使用して CPU Set のリストを表す点が異なります。これは、スレッドの選択された CPU Set がそのホームプロセッサにマップされ、それらのプロセッサが結果のグループアフィニティのリストとして取得されることを意味します。

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

各言語での呼び出し定義

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

BOOL GetThreadSelectedCpuSetMasks(
    HANDLE Thread,
    GROUP_AFFINITY* CpuSetMasks,   // optional
    WORD CpuSetMaskCount,
    WORD* RequiredMaskCount
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool GetThreadSelectedCpuSetMasks(
    IntPtr Thread,   // HANDLE
    IntPtr CpuSetMasks,   // GROUP_AFFINITY* optional, out
    ushort CpuSetMaskCount,   // WORD
    out ushort RequiredMaskCount   // WORD* out
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetThreadSelectedCpuSetMasks(
    Thread As IntPtr,   ' HANDLE
    CpuSetMasks As IntPtr,   ' GROUP_AFFINITY* optional, out
    CpuSetMaskCount As UShort,   ' WORD
    <Out> ByRef RequiredMaskCount As UShort   ' WORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Thread : HANDLE
' CpuSetMasks : GROUP_AFFINITY* optional, out
' CpuSetMaskCount : WORD
' RequiredMaskCount : WORD* out
Declare PtrSafe Function GetThreadSelectedCpuSetMasks Lib "kernel32" ( _
    ByVal Thread As LongPtr, _
    ByVal CpuSetMasks As LongPtr, _
    ByVal CpuSetMaskCount As Integer, _
    ByRef RequiredMaskCount As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetThreadSelectedCpuSetMasks = ctypes.windll.kernel32.GetThreadSelectedCpuSetMasks
GetThreadSelectedCpuSetMasks.restype = wintypes.BOOL
GetThreadSelectedCpuSetMasks.argtypes = [
    wintypes.HANDLE,  # Thread : HANDLE
    ctypes.c_void_p,  # CpuSetMasks : GROUP_AFFINITY* optional, out
    ctypes.c_ushort,  # CpuSetMaskCount : WORD
    ctypes.POINTER(ctypes.c_ushort),  # RequiredMaskCount : WORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetThreadSelectedCpuSetMasks = Fiddle::Function.new(
  lib['GetThreadSelectedCpuSetMasks'],
  [
    Fiddle::TYPE_VOIDP,  # Thread : HANDLE
    Fiddle::TYPE_VOIDP,  # CpuSetMasks : GROUP_AFFINITY* optional, out
    -Fiddle::TYPE_SHORT,  # CpuSetMaskCount : WORD
    Fiddle::TYPE_VOIDP,  # RequiredMaskCount : WORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetThreadSelectedCpuSetMasks(
        Thread: *mut core::ffi::c_void,  // HANDLE
        CpuSetMasks: *mut GROUP_AFFINITY,  // GROUP_AFFINITY* optional, out
        CpuSetMaskCount: u16,  // WORD
        RequiredMaskCount: *mut u16  // WORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool GetThreadSelectedCpuSetMasks(IntPtr Thread, IntPtr CpuSetMasks, ushort CpuSetMaskCount, out ushort RequiredMaskCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetThreadSelectedCpuSetMasks' -Namespace Win32 -PassThru
# $api::GetThreadSelectedCpuSetMasks(Thread, CpuSetMasks, CpuSetMaskCount, RequiredMaskCount)

#uselib "KERNEL32.dll"
#func global GetThreadSelectedCpuSetMasks "GetThreadSelectedCpuSetMasks" sptr, sptr, sptr, sptr
; GetThreadSelectedCpuSetMasks Thread, varptr(CpuSetMasks), CpuSetMaskCount, varptr(RequiredMaskCount)   ; 戻り値は stat
; Thread : HANDLE -> "sptr"
; CpuSetMasks : GROUP_AFFINITY* optional, out -> "sptr"
; CpuSetMaskCount : WORD -> "sptr"
; RequiredMaskCount : WORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetThreadSelectedCpuSetMasks "GetThreadSelectedCpuSetMasks" sptr, var, int, var
; res = GetThreadSelectedCpuSetMasks(Thread, CpuSetMasks, CpuSetMaskCount, RequiredMaskCount)
; Thread : HANDLE -> "sptr"
; CpuSetMasks : GROUP_AFFINITY* optional, out -> "var"
; CpuSetMaskCount : WORD -> "int"
; RequiredMaskCount : WORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetThreadSelectedCpuSetMasks "GetThreadSelectedCpuSetMasks" sptr, sptr, int, sptr
; res = GetThreadSelectedCpuSetMasks(Thread, varptr(CpuSetMasks), CpuSetMaskCount, varptr(RequiredMaskCount))
; Thread : HANDLE -> "sptr"
; CpuSetMasks : GROUP_AFFINITY* optional, out -> "sptr"
; CpuSetMaskCount : WORD -> "int"
; RequiredMaskCount : WORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。