ホーム › System.Threading › SetThreadSelectedCpuSetMasks

SetThreadSelectedCpuSetMasks

関数

スレッドに使用するCPUセットマスクを設定する。

DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

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

パラメーター

名前	型	方向	説明
Thread	HANDLE	in	CPU セット割り当てを設定するスレッドを指定します。PROCESS_SET_LIMITED_INFORMATION アクセス権が必要です。GetCurrentProcess が返す値もここに指定できます。
CpuSetMasks	GROUP_AFFINITY*	inoptional	スレッドの選択 CPU セットとして設定する CPU セットを表す GROUP_AFFINITY 構造体の省略可能なバッファーを指定します。これが NULL の場合、SetThreadSelectedCpuSetMasks 関数はすべての割り当てをクリアし、プロセス既定の割り当てが設定されていればそれに戻します。
CpuSetMaskCount	WORD	in	GroupCpuSets 引数で渡されるリスト内の GROUP_AFFINITY 構造体の数を指定します。バッファーが NULL の場合、この値はゼロでなければなりません。

戻り値の型: BOOL

公式ドキュメント

指定したスレッドの選択 CPU セット割り当てを設定します。この割り当ては、プロセス既定の割り当てが設定されている場合、それを上書きします。(SetThreadSelectedCpuSetMasks)

戻り値

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

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

解説(Remarks)

この関数は SetThreadSelectedCpuSets に類似していますが、CPU セット ID ではなくグループアフィニティを使用して CPU セットのリストを表す点が異なります。これは、結果として得られるスレッドの選択 CPU セット割り当てが、指定したグループアフィニティのリスト内にホームプロセッサを持つすべての CPU セットの集合になることを意味します。

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

各言語での呼び出し定義

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

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

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

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

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

import ctypes
from ctypes import wintypes

SetThreadSelectedCpuSetMasks = ctypes.windll.kernel32.SetThreadSelectedCpuSetMasks
SetThreadSelectedCpuSetMasks.restype = wintypes.BOOL
SetThreadSelectedCpuSetMasks.argtypes = [
    wintypes.HANDLE,  # Thread : HANDLE
    ctypes.c_void_p,  # CpuSetMasks : GROUP_AFFINITY* optional
    ctypes.c_ushort,  # CpuSetMaskCount : WORD
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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