Win32 API 日本語リファレンス
ホームSystem.Threading › SetProcessAffinityUpdateMode

SetProcessAffinityUpdateMode

関数
プロセスのアフィニティ自動更新モードを設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL SetProcessAffinityUpdateMode(
    HANDLE hProcess,
    PROCESS_AFFINITY_AUTO_UPDATE_FLAGS dwFlags
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスへのハンドル。このハンドルは GetCurrentProcess 関数によって返されたものである必要があります。
dwFlagsPROCESS_AFFINITY_AUTO_UPDATE_FLAGSin

アフィニティ更新モード。このパラメーターには次のいずれかの値を指定できます。

意味
0
システムによるプロセスアフィニティの動的更新を無効にします。
PROCESS_AFFINITY_ENABLE_AUTO_UPDATE
0x00000001UL
システムによるプロセスアフィニティの動的更新を有効にします。

戻り値の型: BOOL

公式ドキュメント

指定したプロセスのアフィニティ更新モードを設定します。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

システムは、プロセッサが動的に追加された場合など、さまざまな条件下でプロセスアフィニティを調整できます。既定では、各プロセスに対してプロセスアフィニティの動的更新は無効になっています。

プロセスは、システムによるプロセスアフィニティの動的な調整を処理できるかどうかを示すためにこの関数を使用する必要があります。プロセスがアフィニティ更新モードを有効にした後、この関数を呼び出して無効にすることができます。ただし、この関数を使用して無効にした後は、プロセスはアフィニティ更新モードを有効にできません。

子プロセスは親プロセスのアフィニティ更新モードを継承しません。アフィニティ更新モードは、各子プロセスに対して明示的に設定する必要があります。

この関数を呼び出すアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以降として定義してください。詳細については、Using the Windows Headers を参照してください。

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

各言語での呼び出し定義

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

BOOL SetProcessAffinityUpdateMode(
    HANDLE hProcess,
    PROCESS_AFFINITY_AUTO_UPDATE_FLAGS dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetProcessAffinityUpdateMode(
    IntPtr hProcess,   // HANDLE
    uint dwFlags   // PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetProcessAffinityUpdateMode(
    hProcess As IntPtr,   ' HANDLE
    dwFlags As UInteger   ' PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
Declare PtrSafe Function SetProcessAffinityUpdateMode Lib "kernel32" ( _
    ByVal hProcess As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetProcessAffinityUpdateMode = ctypes.windll.kernel32.SetProcessAffinityUpdateMode
SetProcessAffinityUpdateMode.restype = wintypes.BOOL
SetProcessAffinityUpdateMode.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.DWORD,  # dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetProcessAffinityUpdateMode = Fiddle::Function.new(
  lib['SetProcessAffinityUpdateMode'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_INT,  # dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetProcessAffinityUpdateMode(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        dwFlags: u32  // PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
    ) -> 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 SetProcessAffinityUpdateMode(IntPtr hProcess, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetProcessAffinityUpdateMode' -Namespace Win32 -PassThru
# $api::SetProcessAffinityUpdateMode(hProcess, dwFlags)
#uselib "KERNEL32.dll"
#func global SetProcessAffinityUpdateMode "SetProcessAffinityUpdateMode" sptr, sptr
; SetProcessAffinityUpdateMode hProcess, dwFlags   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetProcessAffinityUpdateMode "SetProcessAffinityUpdateMode" sptr, int
; res = SetProcessAffinityUpdateMode(hProcess, dwFlags)
; hProcess : HANDLE -> "sptr"
; dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> "int"
; BOOL SetProcessAffinityUpdateMode(HANDLE hProcess, PROCESS_AFFINITY_AUTO_UPDATE_FLAGS dwFlags)
#uselib "KERNEL32.dll"
#cfunc global SetProcessAffinityUpdateMode "SetProcessAffinityUpdateMode" intptr, int
; res = SetProcessAffinityUpdateMode(hProcess, dwFlags)
; hProcess : HANDLE -> "intptr"
; dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetProcessAffinityUpdateMode = kernel32.NewProc("SetProcessAffinityUpdateMode")
)

// hProcess (HANDLE), dwFlags (PROCESS_AFFINITY_AUTO_UPDATE_FLAGS)
r1, _, err := procSetProcessAffinityUpdateMode.Call(
	uintptr(hProcess),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetProcessAffinityUpdateMode(
  hProcess: THandle;   // HANDLE
  dwFlags: DWORD   // PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetProcessAffinityUpdateMode';
result := DllCall("KERNEL32\SetProcessAffinityUpdateMode"
    , "Ptr", hProcess   ; HANDLE
    , "UInt", dwFlags   ; PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
    , "Int")   ; return: BOOL
●SetProcessAffinityUpdateMode(hProcess, dwFlags) = DLL("KERNEL32.dll", "bool SetProcessAffinityUpdateMode(void*, dword)")
# 呼び出し: SetProcessAffinityUpdateMode(hProcess, dwFlags)
# hProcess : HANDLE -> "void*"
# dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn SetProcessAffinityUpdateMode(
    hProcess: ?*anyopaque, // HANDLE
    dwFlags: u32 // PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc SetProcessAffinityUpdateMode(
    hProcess: pointer,  # HANDLE
    dwFlags: uint32  # PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
): int32 {.importc: "SetProcessAffinityUpdateMode", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetProcessAffinityUpdateMode(
    void* hProcess,   // HANDLE
    uint dwFlags   // PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
);
ccall((:SetProcessAffinityUpdateMode, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32),
      hProcess, dwFlags)
# hProcess : HANDLE -> Ptr{Cvoid}
# dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetProcessAffinityUpdateMode(
    void* hProcess,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetProcessAffinityUpdateMode(hProcess, dwFlags)
-- hProcess : HANDLE
-- dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetProcessAffinityUpdateMode = lib.func('__stdcall', 'SetProcessAffinityUpdateMode', 'int32_t', ['void *', 'uint32_t']);
// SetProcessAffinityUpdateMode(hProcess, dwFlags)
// hProcess : HANDLE -> 'void *'
// dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetProcessAffinityUpdateMode: { parameters: ["pointer", "u32"], result: "i32" },
});
// lib.symbols.SetProcessAffinityUpdateMode(hProcess, dwFlags)
// hProcess : HANDLE -> "pointer"
// dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetProcessAffinityUpdateMode(
    void* hProcess,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->SetProcessAffinityUpdateMode(hProcess, dwFlags);
// hProcess : HANDLE
// dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
// 構造体/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 SetProcessAffinityUpdateMode(
        Pointer hProcess,   // HANDLE
        int dwFlags   // PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetProcessAffinityUpdateMode = SetProcessAffinityUpdateMode(
    hProcess : Void*,   # HANDLE
    dwFlags : UInt32   # PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetProcessAffinityUpdateModeNative = Int32 Function(Pointer<Void>, Uint32);
typedef SetProcessAffinityUpdateModeDart = int Function(Pointer<Void>, int);
final SetProcessAffinityUpdateMode = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetProcessAffinityUpdateModeNative, SetProcessAffinityUpdateModeDart>('SetProcessAffinityUpdateMode');
// hProcess : HANDLE -> Pointer<Void>
// dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetProcessAffinityUpdateMode(
  hProcess: THandle;   // HANDLE
  dwFlags: DWORD   // PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetProcessAffinityUpdateMode';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetProcessAffinityUpdateMode"
  c_SetProcessAffinityUpdateMode :: Ptr () -> Word32 -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setprocessaffinityupdatemode =
  foreign "SetProcessAffinityUpdateMode"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetProcessAffinityUpdateMode" set-process-affinity-update-mode :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (dw-flags :uint32))   ; PROCESS_AFFINITY_AUTO_UPDATE_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetProcessAffinityUpdateMode = Win32::API::More->new('KERNEL32',
    'BOOL SetProcessAffinityUpdateMode(HANDLE hProcess, DWORD dwFlags)');
# my $ret = $SetProcessAffinityUpdateMode->Call($hProcess, $dwFlags);
# hProcess : HANDLE -> HANDLE
# dwFlags : PROCESS_AFFINITY_AUTO_UPDATE_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型