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

SetProcessWorkingSetSize

関数
プロセスの最小および最大ワーキングセットサイズを設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetProcessWorkingSetSize(
    HANDLE hProcess,
    UINT_PTR dwMinimumWorkingSetSize,
    UINT_PTR dwMaximumWorkingSetSize
);

パラメーター

名前方向説明
hProcessHANDLEin

ワーキングセットサイズを設定するプロセスのハンドル。

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

dwMinimumWorkingSetSizeUINT_PTRin

プロセスのワーキングセットの最小サイズ(バイト単位)。仮想メモリマネージャーは、プロセスがアクティブな間、少なくともこのサイズ分のメモリをプロセス内に常駐させようとします。

このパラメーターは 0 より大きく、かつワーキングセットの最大サイズ以下である必要があります。既定のサイズは 50 ページです(たとえば、4K ページサイズのシステムでは 204,800 バイト)。値が 0 より大きく 20 ページ未満の場合、最小値は 20 ページに設定されます。

dwMinimumWorkingSetSizedwMaximumWorkingSetSize の両方が値 (SIZE_T)–1 の場合、この関数は指定したプロセスのワーキングセットから可能な限り多くのページを削除します。

dwMaximumWorkingSetSizeUINT_PTRin

プロセスのワーキングセットの最大サイズ(バイト単位)。仮想メモリマネージャーは、プロセスがアクティブで利用可能なメモリが少ない間、これを超えるメモリをプロセス内に常駐させないようにします。

このパラメーターは 13 ページ以上(たとえば、4K ページサイズのシステムでは 53,248 バイト)で、かつシステム全体の最大値(利用可能なページ数から 512 ページを引いた値)未満である必要があります。既定のサイズは 345 ページです(たとえば、4K ページサイズのシステムでは 1,413,120 バイト)。

dwMinimumWorkingSetSizedwMaximumWorkingSetSize の両方が値 (SIZE_T)–1 の場合、この関数は指定したプロセスのワーキングセットから可能な限り多くのページを削除します。

戻り値の型: BOOL

公式ドキュメント

指定したプロセスのワーキングセットの最小サイズと最大サイズを設定します。(SetProcessWorkingSetSize)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

プロセスのワーキングセットとは、プロセスの仮想アドレス空間内のメモリページのうち、現在物理メモリに常駐しているものの集合です。これらのページは、ページフォールトを発生させることなくアプリケーションが使用できます。ページフォールトの詳細については、Working Set を参照してください。ワーキングセットの最小サイズと最大サイズは、プロセスの仮想メモリのページング動作に影響します。

最小サイズと最大サイズの両方に値 (SIZE_T)–1 を指定すると、指定したプロセスのワーキングセットを空にできます。これにより、ワーキングセットから可能な限り多くのページが削除されます。この目的には EmptyWorkingSet 関数を使用することもできます。

dwMinimumWorkingSetSize または dwMaximumWorkingSetSize のいずれかの値がプロセスの現在のワーキングセットサイズより大きい場合、指定したプロセスには SE_INC_WORKING_SET_NAME 特権が必要です。一般に、すべてのユーザーがこの特権を持っています。セキュリティ特権の詳細については、 Privileges を参照してください。

Windows Server 2003 および Windows XP: 指定したプロセスには SE_INC_BASE_PRIORITY_NAME 特権が必要です。一般に、Administrators グループおよび Power Users グループのユーザーがこの特権を持っています。

オペレーティングシステムは、ワーキングセットサイズを先着順で割り当てます。たとえば、あるアプリケーションが 64 メガバイトのシステムでワーキングセットの最小サイズを 40 メガバイトに設定することに成功し、2 番目のアプリケーションが 40 メガバイトのワーキングセットサイズを要求した場合、オペレーティングシステムは 2 番目のアプリケーションの要求を拒否します。

SetProcessWorkingSetSize 関数を使用してアプリケーションのワーキングセットの最小サイズと最大サイズを設定しても、要求したメモリが予約されることや、常に常駐し続けることは保証されません。アプリケーションがアイドル状態のとき、またはメモリ不足の状況によりメモリの需要が生じたとき、オペレーティングシステムはアプリケーションのワーキングセットを縮小することがあります。アプリケーションは VirtualLock 関数を使用して、アプリケーションの仮想アドレス空間の範囲をメモリ内にロックできますが、これはシステムのパフォーマンスを低下させる可能性があります。

アプリケーションのワーキングセットサイズを増やすと、システムの他の部分から物理メモリを奪うことになります。これにより、他のアプリケーションやシステム全体のパフォーマンスが低下する可能性があります。また、物理メモリの存在を必要とする操作(たとえば、プロセス、スレッド、カーネルプールの作成)の失敗につながることもあります。したがって、 SetProcessWorkingSetSize 関数は慎重に使用する必要があります。アプリケーションを設計する際は、常にシステム全体のパフォーマンスを考慮しなければなりません。

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

各言語での呼び出し定義

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

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

SetProcessWorkingSetSize = ctypes.windll.kernel32.SetProcessWorkingSetSize
SetProcessWorkingSetSize.restype = wintypes.BOOL
SetProcessWorkingSetSize.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_size_t,  # dwMinimumWorkingSetSize : UINT_PTR
    ctypes.c_size_t,  # dwMaximumWorkingSetSize : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetProcessWorkingSetSize = kernel32.NewProc("SetProcessWorkingSetSize")
)

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

extern "kernel32" fn SetProcessWorkingSetSize(
    hProcess: ?*anyopaque, // HANDLE
    dwMinimumWorkingSetSize: usize, // UINT_PTR
    dwMaximumWorkingSetSize: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;
proc SetProcessWorkingSetSize(
    hProcess: pointer,  # HANDLE
    dwMinimumWorkingSetSize: uint,  # UINT_PTR
    dwMaximumWorkingSetSize: uint  # UINT_PTR
): int32 {.importc: "SetProcessWorkingSetSize", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetProcessWorkingSetSize(
    void* hProcess,   // HANDLE
    size_t dwMinimumWorkingSetSize,   // UINT_PTR
    size_t dwMaximumWorkingSetSize   // UINT_PTR
);
ccall((:SetProcessWorkingSetSize, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Csize_t, Csize_t),
      hProcess, dwMinimumWorkingSetSize, dwMaximumWorkingSetSize)
# hProcess : HANDLE -> Ptr{Cvoid}
# dwMinimumWorkingSetSize : UINT_PTR -> Csize_t
# dwMaximumWorkingSetSize : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetProcessWorkingSetSize(
    void* hProcess,
    uintptr_t dwMinimumWorkingSetSize,
    uintptr_t dwMaximumWorkingSetSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetProcessWorkingSetSize(hProcess, dwMinimumWorkingSetSize, dwMaximumWorkingSetSize)
-- hProcess : HANDLE
-- dwMinimumWorkingSetSize : UINT_PTR
-- dwMaximumWorkingSetSize : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetProcessWorkingSetSize = lib.func('__stdcall', 'SetProcessWorkingSetSize', 'int32_t', ['void *', 'uintptr_t', 'uintptr_t']);
// SetProcessWorkingSetSize(hProcess, dwMinimumWorkingSetSize, dwMaximumWorkingSetSize)
// hProcess : HANDLE -> 'void *'
// dwMinimumWorkingSetSize : UINT_PTR -> 'uintptr_t'
// dwMaximumWorkingSetSize : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetProcessWorkingSetSize: { parameters: ["pointer", "usize", "usize"], result: "i32" },
});
// lib.symbols.SetProcessWorkingSetSize(hProcess, dwMinimumWorkingSetSize, dwMaximumWorkingSetSize)
// hProcess : HANDLE -> "pointer"
// dwMinimumWorkingSetSize : UINT_PTR -> "usize"
// dwMaximumWorkingSetSize : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetProcessWorkingSetSize(
    void* hProcess,
    size_t dwMinimumWorkingSetSize,
    size_t dwMaximumWorkingSetSize);
C, "KERNEL32.dll");
// $ffi->SetProcessWorkingSetSize(hProcess, dwMinimumWorkingSetSize, dwMaximumWorkingSetSize);
// hProcess : HANDLE
// dwMinimumWorkingSetSize : UINT_PTR
// dwMaximumWorkingSetSize : 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 SetProcessWorkingSetSize(
        Pointer hProcess,   // HANDLE
        long dwMinimumWorkingSetSize,   // UINT_PTR
        long dwMaximumWorkingSetSize   // UINT_PTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetProcessWorkingSetSize = SetProcessWorkingSetSize(
    hProcess : Void*,   # HANDLE
    dwMinimumWorkingSetSize : LibC::SizeT,   # UINT_PTR
    dwMaximumWorkingSetSize : 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 SetProcessWorkingSetSizeNative = Int32 Function(Pointer<Void>, UintPtr, UintPtr);
typedef SetProcessWorkingSetSizeDart = int Function(Pointer<Void>, int, int);
final SetProcessWorkingSetSize = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetProcessWorkingSetSizeNative, SetProcessWorkingSetSizeDart>('SetProcessWorkingSetSize');
// hProcess : HANDLE -> Pointer<Void>
// dwMinimumWorkingSetSize : UINT_PTR -> UintPtr
// dwMaximumWorkingSetSize : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetProcessWorkingSetSize(
  hProcess: THandle;   // HANDLE
  dwMinimumWorkingSetSize: NativeUInt;   // UINT_PTR
  dwMaximumWorkingSetSize: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetProcessWorkingSetSize';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setprocessworkingsetsize =
  foreign "SetProcessWorkingSetSize"
    ((ptr void) @-> size_t @-> size_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* dwMinimumWorkingSetSize : UINT_PTR -> size_t *)
(* dwMaximumWorkingSetSize : 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 ("SetProcessWorkingSetSize" set-process-working-set-size :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (dw-minimum-working-set-size :uint64)   ; UINT_PTR
  (dw-maximum-working-set-size :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetProcessWorkingSetSize = Win32::API::More->new('KERNEL32',
    'BOOL SetProcessWorkingSetSize(HANDLE hProcess, WPARAM dwMinimumWorkingSetSize, WPARAM dwMaximumWorkingSetSize)');
# my $ret = $SetProcessWorkingSetSize->Call($hProcess, $dwMinimumWorkingSetSize, $dwMaximumWorkingSetSize);
# hProcess : HANDLE -> HANDLE
# dwMinimumWorkingSetSize : UINT_PTR -> WPARAM
# dwMaximumWorkingSetSize : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目