ホーム › System.Threading › GetProcessAffinityMask

GetProcessAffinityMask

関数

プロセスとシステムのプロセッサアフィニティマスクを取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL GetProcessAffinityMask(
    HANDLE hProcess,
    UINT_PTR* lpProcessAffinityMask,
    UINT_PTR* lpSystemAffinityMask
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	アフィニティマスクを取得するプロセスへのハンドル。このハンドルには PROCESS_QUERY_INFORMATION または PROCESS_QUERY_LIMITED_INFORMATION アクセス権が必要です。詳細については、 Process Security and Access Rights を参照してください。 Windows Server 2003 および Windows XP: このハンドルには PROCESS_QUERY_INFORMATION アクセス権が必要です。
lpProcessAffinityMask	UINT_PTR*	out	指定したプロセスのアフィニティマスクを受け取る変数へのポインター。
lpSystemAffinityMask	UINT_PTR*	out	システムのアフィニティマスクを受け取る変数へのポインター。

名前

型

方向

説明

hProcess

HANDLE

アフィニティマスクを取得するプロセスへのハンドル。

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

Windows Server 2003 および Windows XP: このハンドルには PROCESS_QUERY_INFORMATION アクセス権が必要です。

lpProcessAffinityMask

UINT_PTR*

out

指定したプロセスのアフィニティマスクを受け取る変数へのポインター。

lpSystemAffinityMask

UINT_PTR*

out

システムのアフィニティマスクを受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定したプロセスのプロセスアフィニティマスクと、システムのシステムアフィニティマスクを取得します。

戻り値

関数が成功すると、戻り値は 0 以外になり、lpProcessAffinityMask と lpSystemAffinityMask が指す変数に適切なアフィニティマスクが設定されます。

64 個を超えるプロセッサを搭載したシステムでは、呼び出し元プロセスのスレッドが単一のプロセッサグループ内にある場合、この関数は lpProcessAffinityMask と lpSystemAffinityMask が指す変数に、そのグループのプロセスアフィニティマスクおよびアクティブな論理プロセッサのプロセッサマスクを設定します。呼び出し元プロセスが複数のグループにスレッドを含む場合、この関数は両方のアフィニティマスクに対して 0 を返します。

関数が失敗した場合、戻り値は 0 になり、lpProcessAffinityMask と lpSystemAffinityMask が指す変数の値は未定義です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

プロセスアフィニティマスクは、各ビットがプロセスの実行を許可されたプロセッサを表すビットベクトルです。システムアフィニティマスクは、各ビットがシステムに構成されているプロセッサを表すビットベクトルです。

プロセスアフィニティマスクはシステムアフィニティマスクのサブセットです。プロセスはシステムに構成されたプロセッサ上でのみ実行を許可されます。したがって、システムアフィニティマスクがあるプロセッサに対して 0 ビットを指定している場合、プロセスアフィニティマスクはそのプロセッサに対して 1 ビットを指定することはできません。

Windows 11 および Windows Server 2022 以降では、64 個を超えるプロセッサを搭載したシステムにおいて、プロセスおよびスレッドのアフィニティは既定ですべてのプロセッサグループにまたがり、システム内のすべてのプロセッサに及びます。GetProcessAffinityMask 関数は、lpProcessAffinityMask と lpSystemAffinityMask に、プロセスのプライマリグループにおけるプロセスおよびシステムのプロセッサマスクを設定します。プロセスが 1 つ以上のスレッドのアフィニティをプロセスのプライマリグループの外に明示的に設定していた場合、この関数は両方のアフィニティマスクに対して 0 を返します。ただし、hHandle が現在のプロセスへのハンドルを指定している場合、この関数は lpProcessAffinityMask と lpSystemAffinityMask を設定するために、常に呼び出し元スレッドのプライマリグループ(既定ではプロセスのプライマリグループと同じ)を使用します。

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

各言語での呼び出し定義

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

BOOL GetProcessAffinityMask(
    HANDLE hProcess,
    UINT_PTR* lpProcessAffinityMask,
    UINT_PTR* lpSystemAffinityMask
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetProcessAffinityMask(
    IntPtr hProcess,   // HANDLE
    out UIntPtr lpProcessAffinityMask,   // UINT_PTR* out
    out UIntPtr lpSystemAffinityMask   // UINT_PTR* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetProcessAffinityMask(
    hProcess As IntPtr,   ' HANDLE
    <Out> ByRef lpProcessAffinityMask As UIntPtr,   ' UINT_PTR* out
    <Out> ByRef lpSystemAffinityMask As UIntPtr   ' UINT_PTR* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' lpProcessAffinityMask : UINT_PTR* out
' lpSystemAffinityMask : UINT_PTR* out
Declare PtrSafe Function GetProcessAffinityMask Lib "kernel32" ( _
    ByVal hProcess As LongPtr, _
    ByRef lpProcessAffinityMask As LongPtr, _
    ByRef lpSystemAffinityMask As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetProcessAffinityMask = ctypes.windll.kernel32.GetProcessAffinityMask
GetProcessAffinityMask.restype = wintypes.BOOL
GetProcessAffinityMask.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.POINTER(ctypes.c_size_t),  # lpProcessAffinityMask : UINT_PTR* out
    ctypes.POINTER(ctypes.c_size_t),  # lpSystemAffinityMask : UINT_PTR* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetProcessAffinityMask = Fiddle::Function.new(
  lib['GetProcessAffinityMask'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # lpProcessAffinityMask : UINT_PTR* out
    Fiddle::TYPE_VOIDP,  # lpSystemAffinityMask : UINT_PTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetProcessAffinityMask(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        lpProcessAffinityMask: *mut usize,  // UINT_PTR* out
        lpSystemAffinityMask: *mut usize  // UINT_PTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetProcessAffinityMask(IntPtr hProcess, out UIntPtr lpProcessAffinityMask, out UIntPtr lpSystemAffinityMask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetProcessAffinityMask' -Namespace Win32 -PassThru
# $api::GetProcessAffinityMask(hProcess, lpProcessAffinityMask, lpSystemAffinityMask)

#uselib "KERNEL32.dll"
#func global GetProcessAffinityMask "GetProcessAffinityMask" sptr, sptr, sptr
; GetProcessAffinityMask hProcess, varptr(lpProcessAffinityMask), varptr(lpSystemAffinityMask)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; lpProcessAffinityMask : UINT_PTR* out -> "sptr"
; lpSystemAffinityMask : UINT_PTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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