ホーム › System.Threading › SetProcessDefaultCpuSetMasks

SetProcessDefaultCpuSetMasks

関数

プロセスの既定CPUセットをグループアフィニティマスクで設定する。

DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL SetProcessDefaultCpuSetMasks(
    HANDLE Process,
    GROUP_AFFINITY* CpuSetMasks,   // optional
    WORD CpuSetMaskCount
);

パラメーター

名前	型	方向	説明
Process	HANDLE	in	既定の CPU Sets を設定する対象のプロセスを指定します。このハンドルには PROCESS_SET_LIMITED_INFORMATION アクセス権が必要です。GetCurrentProcess が返す値もここで指定できます。
CpuSetMasks	GROUP_AFFINITY*	inoptional	プロセスの既定の CPU Set として設定する CPU Sets を表す、GROUP_AFFINITY 構造体の省略可能なバッファーを指定します。これが NULL の場合、SetProcessDefaultCpuSetMasks 関数はすべての割り当てを解除します。
CpuSetMaskCount	WORD	in	CpuSetMasks 配列のサイズを要素数で指定します。バッファーが NULL の場合、この値は 0 でなければなりません。

戻り値の型: BOOL

公式ドキュメント

SetProcessDefaultCpuSetMasks 関数 (processthreadsapi.h) は、指定したプロセス内のスレッドに対する既定の CPU Sets 割り当てを設定します。

戻り値

この関数は、有効なパラメーターが渡された場合は失敗しません。

解説(Remarks)

SetThreadSelectedCpuSetMasks または SetThreadSelectedCpuSets を使用して CPU Sets を明示的に設定していない、このプロセスに属するスレッドは、SetProcessDefaultCpuSetMasks で指定されたセットを自動的に継承します。

この関数は SetProcessDefaultCpuSets に類似していますが、CPU Set ID ではなくグループアフィニティを使用して CPU セットのリストを表す点が異なります。つまり、結果として得られるプロセスの既定の CPU Set 割り当ては、指定されたグループアフィニティのリスト内にホームプロセッサを持つすべての 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 SetProcessDefaultCpuSetMasks(
    HANDLE Process,
    GROUP_AFFINITY* CpuSetMasks,   // optional
    WORD CpuSetMaskCount
);

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

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

' Process : HANDLE
' CpuSetMasks : GROUP_AFFINITY* optional
' CpuSetMaskCount : WORD
Declare PtrSafe Function SetProcessDefaultCpuSetMasks Lib "kernel32" ( _
    ByVal Process 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "kernel32")]
extern "system" {
    fn SetProcessDefaultCpuSetMasks(
        Process: *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 SetProcessDefaultCpuSetMasks(IntPtr Process, IntPtr CpuSetMasks, ushort CpuSetMaskCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetProcessDefaultCpuSetMasks' -Namespace Win32 -PassThru
# $api::SetProcessDefaultCpuSetMasks(Process, CpuSetMasks, CpuSetMaskCount)

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

出力引数:

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