SetProcessAffinityMask
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL SetProcessAffinityMask(
HANDLE hProcess,
UINT_PTR dwProcessAffinityMask
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hProcess | HANDLE | in | アフィニティマスクを設定するプロセスのハンドル。このハンドルには PROCESS_SET_INFORMATION アクセス権が必要です。詳細については、 Process Security and Access Rights を参照してください。 |
| dwProcessAffinityMask | UINT_PTR | in | プロセスのスレッドに対するアフィニティマスク。 64 を超えるプロセッサを搭載したシステムでは、アフィニティマスクは単一のプロセッサグループ内のプロセッサを指定する必要があります。 |
戻り値の型: BOOL
公式ドキュメント
指定したプロセスのスレッドにプロセッサアフィニティマスクを設定します。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。
プロセスアフィニティマスクがシステムに構成されていないプロセッサを要求した場合、最後のエラーコードは ERROR_INVALID_PARAMETER になります。
64 を超えるプロセッサを搭載したシステムで、呼び出し元のプロセスが複数のプロセッサグループにまたがるスレッドを含む場合、最後のエラーコードは ERROR_INVALID_PARAMETER になります。
解説(Remarks)
プロセスアフィニティマスクは、各ビットがプロセスのスレッドの実行を許可する論理プロセッサを表すビットベクトルです。プロセスアフィニティマスクの値は、 GetProcessAffinityMask 関数で取得されるシステムアフィニティマスクの値のサブセットでなければなりません。プロセスは、システムに構成されたプロセッサ上でのみ実行が許可されます。したがって、システムアフィニティマスクが特定のプロセッサに対して 0 ビットを指定している場合、プロセスアフィニティマスクはそのプロセッサに対して 1 ビットを指定できません。
プロセスアフィニティは、子プロセスや新たに生成されるローカルプロセスに継承されます。
自分以外のプロセスから呼び出される可能性のある DLL 内で SetProcessAffinityMask を呼び出さないでください。
64 を超えるプロセッサを搭載したシステムでは、SetProcessAffinityMask 関数は、単一のプロセッサグループ内にスレッドを持つプロセスに対してのみプロセスアフィニティマスクを設定するために使用できます。複数のグループにまたがる個々のスレッドのアフィニティマスクを設定するには、SetThreadAffinityMask 関数を使用します。これにより、実質的にプロセスのグループ割り当てが変更されます。
Windows 11 および Windows Server 2022 以降では、64 を超えるプロセッサを搭載したシステムにおいて、プロセスおよびスレッドのアフィニティは既定で、すべてのプロセッサグループにまたがるシステム内のすべてのプロセッサに及びます。呼び出し元のプロセスが複数のプロセッサグループにまたがるスレッドを含む場合に常に失敗するのではなく、SetProcessAffinityMask 関数は、プロセスがそのスレッドの 1 つ以上のアフィニティをプロセスのプライマリグループ外に明示的に設定していた場合に失敗します(最後のエラーコード ERROR_INVALID_PARAMETER とともに 0 を返します)。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL SetProcessAffinityMask(
HANDLE hProcess,
UINT_PTR dwProcessAffinityMask
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetProcessAffinityMask(
IntPtr hProcess, // HANDLE
UIntPtr dwProcessAffinityMask // UINT_PTR
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetProcessAffinityMask(
hProcess As IntPtr, ' HANDLE
dwProcessAffinityMask As UIntPtr ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hProcess : HANDLE
' dwProcessAffinityMask : UINT_PTR
Declare PtrSafe Function SetProcessAffinityMask Lib "kernel32" ( _
ByVal hProcess As LongPtr, _
ByVal dwProcessAffinityMask As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetProcessAffinityMask = ctypes.windll.kernel32.SetProcessAffinityMask
SetProcessAffinityMask.restype = wintypes.BOOL
SetProcessAffinityMask.argtypes = [
wintypes.HANDLE, # hProcess : HANDLE
ctypes.c_size_t, # dwProcessAffinityMask : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
SetProcessAffinityMask = Fiddle::Function.new(
lib['SetProcessAffinityMask'],
[
Fiddle::TYPE_VOIDP, # hProcess : HANDLE
Fiddle::TYPE_UINTPTR_T, # dwProcessAffinityMask : UINT_PTR
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn SetProcessAffinityMask(
hProcess: *mut core::ffi::c_void, // HANDLE
dwProcessAffinityMask: usize // UINT_PTR
) -> 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 SetProcessAffinityMask(IntPtr hProcess, UIntPtr dwProcessAffinityMask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetProcessAffinityMask' -Namespace Win32 -PassThru
# $api::SetProcessAffinityMask(hProcess, dwProcessAffinityMask)#uselib "KERNEL32.dll"
#func global SetProcessAffinityMask "SetProcessAffinityMask" sptr, sptr
; SetProcessAffinityMask hProcess, dwProcessAffinityMask ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; dwProcessAffinityMask : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global SetProcessAffinityMask "SetProcessAffinityMask" sptr, sptr
; res = SetProcessAffinityMask(hProcess, dwProcessAffinityMask)
; hProcess : HANDLE -> "sptr"
; dwProcessAffinityMask : UINT_PTR -> "sptr"; BOOL SetProcessAffinityMask(HANDLE hProcess, UINT_PTR dwProcessAffinityMask)
#uselib "KERNEL32.dll"
#cfunc global SetProcessAffinityMask "SetProcessAffinityMask" intptr, intptr
; res = SetProcessAffinityMask(hProcess, dwProcessAffinityMask)
; hProcess : HANDLE -> "intptr"
; dwProcessAffinityMask : UINT_PTR -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSetProcessAffinityMask = kernel32.NewProc("SetProcessAffinityMask")
)
// hProcess (HANDLE), dwProcessAffinityMask (UINT_PTR)
r1, _, err := procSetProcessAffinityMask.Call(
uintptr(hProcess),
uintptr(dwProcessAffinityMask),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetProcessAffinityMask(
hProcess: THandle; // HANDLE
dwProcessAffinityMask: NativeUInt // UINT_PTR
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetProcessAffinityMask';result := DllCall("KERNEL32\SetProcessAffinityMask"
, "Ptr", hProcess ; HANDLE
, "UPtr", dwProcessAffinityMask ; UINT_PTR
, "Int") ; return: BOOL●SetProcessAffinityMask(hProcess, dwProcessAffinityMask) = DLL("KERNEL32.dll", "bool SetProcessAffinityMask(void*, int)")
# 呼び出し: SetProcessAffinityMask(hProcess, dwProcessAffinityMask)
# hProcess : HANDLE -> "void*"
# dwProcessAffinityMask : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn SetProcessAffinityMask(
hProcess: ?*anyopaque, // HANDLE
dwProcessAffinityMask: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;proc SetProcessAffinityMask(
hProcess: pointer, # HANDLE
dwProcessAffinityMask: uint # UINT_PTR
): int32 {.importc: "SetProcessAffinityMask", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int SetProcessAffinityMask(
void* hProcess, // HANDLE
size_t dwProcessAffinityMask // UINT_PTR
);ccall((:SetProcessAffinityMask, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Csize_t),
hProcess, dwProcessAffinityMask)
# hProcess : HANDLE -> Ptr{Cvoid}
# dwProcessAffinityMask : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SetProcessAffinityMask(
void* hProcess,
uintptr_t dwProcessAffinityMask);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetProcessAffinityMask(hProcess, dwProcessAffinityMask)
-- hProcess : HANDLE
-- dwProcessAffinityMask : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetProcessAffinityMask = lib.func('__stdcall', 'SetProcessAffinityMask', 'int32_t', ['void *', 'uintptr_t']);
// SetProcessAffinityMask(hProcess, dwProcessAffinityMask)
// hProcess : HANDLE -> 'void *'
// dwProcessAffinityMask : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SetProcessAffinityMask: { parameters: ["pointer", "usize"], result: "i32" },
});
// lib.symbols.SetProcessAffinityMask(hProcess, dwProcessAffinityMask)
// hProcess : HANDLE -> "pointer"
// dwProcessAffinityMask : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetProcessAffinityMask(
void* hProcess,
size_t dwProcessAffinityMask);
C, "KERNEL32.dll");
// $ffi->SetProcessAffinityMask(hProcess, dwProcessAffinityMask);
// hProcess : HANDLE
// dwProcessAffinityMask : UINT_PTR
// 構造体/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 SetProcessAffinityMask(
Pointer hProcess, // HANDLE
long dwProcessAffinityMask // UINT_PTR
);
}@[Link("kernel32")]
lib LibKERNEL32
fun SetProcessAffinityMask = SetProcessAffinityMask(
hProcess : Void*, # HANDLE
dwProcessAffinityMask : LibC::SizeT # UINT_PTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetProcessAffinityMaskNative = Int32 Function(Pointer<Void>, UintPtr);
typedef SetProcessAffinityMaskDart = int Function(Pointer<Void>, int);
final SetProcessAffinityMask = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SetProcessAffinityMaskNative, SetProcessAffinityMaskDart>('SetProcessAffinityMask');
// hProcess : HANDLE -> Pointer<Void>
// dwProcessAffinityMask : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetProcessAffinityMask(
hProcess: THandle; // HANDLE
dwProcessAffinityMask: NativeUInt // UINT_PTR
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetProcessAffinityMask';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetProcessAffinityMask"
c_SetProcessAffinityMask :: Ptr () -> CUIntPtr -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- dwProcessAffinityMask : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setprocessaffinitymask =
foreign "SetProcessAffinityMask"
((ptr void) @-> size_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* dwProcessAffinityMask : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("SetProcessAffinityMask" set-process-affinity-mask :convention :stdcall) :int32
(h-process :pointer) ; HANDLE
(dw-process-affinity-mask :uint64)) ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetProcessAffinityMask = Win32::API::More->new('KERNEL32',
'BOOL SetProcessAffinityMask(HANDLE hProcess, WPARAM dwProcessAffinityMask)');
# my $ret = $SetProcessAffinityMask->Call($hProcess, $dwProcessAffinityMask);
# hProcess : HANDLE -> HANDLE
# dwProcessAffinityMask : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CreateProcessW — 新しいプロセスとそのプライマリスレッドを作成する(Unicode版)。
- f GetProcessAffinityMask — プロセスとシステムのプロセッサアフィニティマスクを取得する。
- f SetThreadAffinityMask — スレッドのプロセッサアフィニティマスクを設定する。