ホーム › System.Threading › GetProcessGroupAffinity
GetProcessGroupAffinity
関数プロセスが割り当てられたプロセッサグループを取得する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL GetProcessGroupAffinity(
HANDLE hProcess,
WORD* GroupCount,
WORD* GroupArray
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hProcess | HANDLE | in | プロセスへのハンドル。 このハンドルには PROCESS_QUERY_INFORMATION または PROCESS_QUERY_LIMITED_INFORMATION のアクセス権が必要です。詳細については、 Process Security and Access Rights を参照してください。 |
| GroupCount | WORD* | inout | 入力時には GroupArray 配列の要素数を指定します。出力時には配列に書き込まれたプロセッサグループの数が設定されます。配列が小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFER で失敗し、GroupCount パラメーターに必要な要素数を設定します。 |
| GroupArray | WORD* | out | プロセッサグループ番号の配列。プロセス内のスレッドがそのグループ内のプロセッサに割り当てられている場合、そのグループ番号が配列に含まれます。 |
戻り値の型: BOOL
公式ドキュメント
指定したプロセスのプロセッサグループアフィニティを取得します。
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を使用します。
エラー値が ERROR_INSUFFICIENT_BUFFER の場合、GroupCount パラメーターには必要なバッファーサイズが要素数で格納されます。
解説(Remarks)
Windows 11 および Windows Server 2022 以降では、64 個を超えるプロセッサを搭載したシステムにおいて、プロセスおよびスレッドのアフィニティは既定ですべての processor groups にわたってシステム内のすべてのプロセッサに及びます。
この関数を使用するアプリケーションをコンパイルするには、_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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL GetProcessGroupAffinity(
HANDLE hProcess,
WORD* GroupCount,
WORD* GroupArray
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool GetProcessGroupAffinity(
IntPtr hProcess, // HANDLE
ref ushort GroupCount, // WORD* in/out
out ushort GroupArray // WORD* out
);<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetProcessGroupAffinity(
hProcess As IntPtr, ' HANDLE
ByRef GroupCount As UShort, ' WORD* in/out
<Out> ByRef GroupArray As UShort ' WORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hProcess : HANDLE
' GroupCount : WORD* in/out
' GroupArray : WORD* out
Declare PtrSafe Function GetProcessGroupAffinity Lib "kernel32" ( _
ByVal hProcess As LongPtr, _
ByRef GroupCount As Integer, _
ByRef GroupArray As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetProcessGroupAffinity = ctypes.windll.kernel32.GetProcessGroupAffinity
GetProcessGroupAffinity.restype = wintypes.BOOL
GetProcessGroupAffinity.argtypes = [
wintypes.HANDLE, # hProcess : HANDLE
ctypes.POINTER(ctypes.c_ushort), # GroupCount : WORD* in/out
ctypes.POINTER(ctypes.c_ushort), # GroupArray : WORD* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
GetProcessGroupAffinity = Fiddle::Function.new(
lib['GetProcessGroupAffinity'],
[
Fiddle::TYPE_VOIDP, # hProcess : HANDLE
Fiddle::TYPE_VOIDP, # GroupCount : WORD* in/out
Fiddle::TYPE_VOIDP, # GroupArray : WORD* out
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn GetProcessGroupAffinity(
hProcess: *mut core::ffi::c_void, // HANDLE
GroupCount: *mut u16, // WORD* in/out
GroupArray: *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 GetProcessGroupAffinity(IntPtr hProcess, ref ushort GroupCount, out ushort GroupArray);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetProcessGroupAffinity' -Namespace Win32 -PassThru
# $api::GetProcessGroupAffinity(hProcess, GroupCount, GroupArray)#uselib "KERNEL32.dll"
#func global GetProcessGroupAffinity "GetProcessGroupAffinity" sptr, sptr, sptr
; GetProcessGroupAffinity hProcess, varptr(GroupCount), varptr(GroupArray) ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; GroupCount : WORD* in/out -> "sptr"
; GroupArray : WORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global GetProcessGroupAffinity "GetProcessGroupAffinity" sptr, var, var ; res = GetProcessGroupAffinity(hProcess, GroupCount, GroupArray) ; hProcess : HANDLE -> "sptr" ; GroupCount : WORD* in/out -> "var" ; GroupArray : WORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global GetProcessGroupAffinity "GetProcessGroupAffinity" sptr, sptr, sptr ; res = GetProcessGroupAffinity(hProcess, varptr(GroupCount), varptr(GroupArray)) ; hProcess : HANDLE -> "sptr" ; GroupCount : WORD* in/out -> "sptr" ; GroupArray : WORD* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL GetProcessGroupAffinity(HANDLE hProcess, WORD* GroupCount, WORD* GroupArray) #uselib "KERNEL32.dll" #cfunc global GetProcessGroupAffinity "GetProcessGroupAffinity" intptr, var, var ; res = GetProcessGroupAffinity(hProcess, GroupCount, GroupArray) ; hProcess : HANDLE -> "intptr" ; GroupCount : WORD* in/out -> "var" ; GroupArray : WORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetProcessGroupAffinity(HANDLE hProcess, WORD* GroupCount, WORD* GroupArray) #uselib "KERNEL32.dll" #cfunc global GetProcessGroupAffinity "GetProcessGroupAffinity" intptr, intptr, intptr ; res = GetProcessGroupAffinity(hProcess, varptr(GroupCount), varptr(GroupArray)) ; hProcess : HANDLE -> "intptr" ; GroupCount : WORD* in/out -> "intptr" ; GroupArray : WORD* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procGetProcessGroupAffinity = kernel32.NewProc("GetProcessGroupAffinity")
)
// hProcess (HANDLE), GroupCount (WORD* in/out), GroupArray (WORD* out)
r1, _, err := procGetProcessGroupAffinity.Call(
uintptr(hProcess),
uintptr(GroupCount),
uintptr(GroupArray),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction GetProcessGroupAffinity(
hProcess: THandle; // HANDLE
GroupCount: Pointer; // WORD* in/out
GroupArray: Pointer // WORD* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'GetProcessGroupAffinity';result := DllCall("KERNEL32\GetProcessGroupAffinity"
, "Ptr", hProcess ; HANDLE
, "Ptr", GroupCount ; WORD* in/out
, "Ptr", GroupArray ; WORD* out
, "Int") ; return: BOOL●GetProcessGroupAffinity(hProcess, GroupCount, GroupArray) = DLL("KERNEL32.dll", "bool GetProcessGroupAffinity(void*, void*, void*)")
# 呼び出し: GetProcessGroupAffinity(hProcess, GroupCount, GroupArray)
# hProcess : HANDLE -> "void*"
# GroupCount : WORD* in/out -> "void*"
# GroupArray : WORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn GetProcessGroupAffinity(
hProcess: ?*anyopaque, // HANDLE
GroupCount: [*c]u16, // WORD* in/out
GroupArray: [*c]u16 // WORD* out
) callconv(std.os.windows.WINAPI) i32;proc GetProcessGroupAffinity(
hProcess: pointer, # HANDLE
GroupCount: ptr uint16, # WORD* in/out
GroupArray: ptr uint16 # WORD* out
): int32 {.importc: "GetProcessGroupAffinity", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int GetProcessGroupAffinity(
void* hProcess, // HANDLE
ushort* GroupCount, // WORD* in/out
ushort* GroupArray // WORD* out
);ccall((:GetProcessGroupAffinity, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{UInt16}, Ptr{UInt16}),
hProcess, GroupCount, GroupArray)
# hProcess : HANDLE -> Ptr{Cvoid}
# GroupCount : WORD* in/out -> Ptr{UInt16}
# GroupArray : WORD* out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t GetProcessGroupAffinity(
void* hProcess,
uint16_t* GroupCount,
uint16_t* GroupArray);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetProcessGroupAffinity(hProcess, GroupCount, GroupArray)
-- hProcess : HANDLE
-- GroupCount : WORD* in/out
-- GroupArray : WORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetProcessGroupAffinity = lib.func('__stdcall', 'GetProcessGroupAffinity', 'int32_t', ['void *', 'uint16_t *', 'uint16_t *']);
// GetProcessGroupAffinity(hProcess, GroupCount, GroupArray)
// hProcess : HANDLE -> 'void *'
// GroupCount : WORD* in/out -> 'uint16_t *'
// GroupArray : WORD* out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GetProcessGroupAffinity: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetProcessGroupAffinity(hProcess, GroupCount, GroupArray)
// hProcess : HANDLE -> "pointer"
// GroupCount : WORD* in/out -> "pointer"
// GroupArray : WORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t GetProcessGroupAffinity(
void* hProcess,
uint16_t* GroupCount,
uint16_t* GroupArray);
C, "KERNEL32.dll");
// $ffi->GetProcessGroupAffinity(hProcess, GroupCount, GroupArray);
// hProcess : HANDLE
// GroupCount : WORD* in/out
// GroupArray : WORD* 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 GetProcessGroupAffinity(
Pointer hProcess, // HANDLE
ShortByReference GroupCount, // WORD* in/out
ShortByReference GroupArray // WORD* out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun GetProcessGroupAffinity = GetProcessGroupAffinity(
hProcess : Void*, # HANDLE
GroupCount : UInt16*, # WORD* in/out
GroupArray : UInt16* # WORD* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetProcessGroupAffinityNative = Int32 Function(Pointer<Void>, Pointer<Uint16>, Pointer<Uint16>);
typedef GetProcessGroupAffinityDart = int Function(Pointer<Void>, Pointer<Uint16>, Pointer<Uint16>);
final GetProcessGroupAffinity = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetProcessGroupAffinityNative, GetProcessGroupAffinityDart>('GetProcessGroupAffinity');
// hProcess : HANDLE -> Pointer<Void>
// GroupCount : WORD* in/out -> Pointer<Uint16>
// GroupArray : WORD* out -> Pointer<Uint16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetProcessGroupAffinity(
hProcess: THandle; // HANDLE
GroupCount: Pointer; // WORD* in/out
GroupArray: Pointer // WORD* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'GetProcessGroupAffinity';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetProcessGroupAffinity"
c_GetProcessGroupAffinity :: Ptr () -> Ptr Word16 -> Ptr Word16 -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- GroupCount : WORD* in/out -> Ptr Word16
-- GroupArray : WORD* out -> Ptr Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getprocessgroupaffinity =
foreign "GetProcessGroupAffinity"
((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* GroupCount : WORD* in/out -> (ptr uint16_t) *)
(* GroupArray : WORD* out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("GetProcessGroupAffinity" get-process-group-affinity :convention :stdcall) :int32
(h-process :pointer) ; HANDLE
(group-count :pointer) ; WORD* in/out
(group-array :pointer)) ; WORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetProcessGroupAffinity = Win32::API::More->new('KERNEL32',
'BOOL GetProcessGroupAffinity(HANDLE hProcess, LPVOID GroupCount, LPVOID GroupArray)');
# my $ret = $GetProcessGroupAffinity->Call($hProcess, $GroupCount, $GroupArray);
# hProcess : HANDLE -> HANDLE
# GroupCount : WORD* in/out -> LPVOID
# GroupArray : WORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f GetThreadGroupAffinity — スレッドのグループアフィニティを取得する。