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

SetSystemFileCacheSize

関数
システムファイルキャッシュの最小・最大サイズを設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL SetSystemFileCacheSize(
    UINT_PTR MinimumFileCacheSize,
    UINT_PTR MaximumFileCacheSize,
    DWORD Flags
);

パラメーター

名前方向説明
MinimumFileCacheSizeUINT_PTRin

ファイルキャッシュの最小サイズ(バイト単位)。仮想メモリマネージャーは、システムファイルキャッシュ内に少なくともこのサイズのメモリを常駐させるよう試みます。

キャッシュをフラッシュするには、(SIZE_T) -1 を指定します。

MaximumFileCacheSizeUINT_PTRin

ファイルキャッシュの最大サイズ(バイト単位)。仮想メモリマネージャーは、この呼び出しまたは以前の SetSystemFileCacheSize の呼び出しで FILE_CACHE_MAX_HARD_ENABLE が指定されている場合にのみ、この制限を適用します。

キャッシュをフラッシュするには、(SIZE_T) -1 を指定します。

FlagsDWORDin

ファイルキャッシュの制限を有効または無効にするフラグです。このパラメーターが 0(ゼロ)の場合、サイズ制限は現在の設定(無効または有効)を保持します。

Value Meaning
FILE_CACHE_MAX_HARD_DISABLE
0x2
最大サイズ制限を無効にします。

FILE_CACHE_MAX_HARD_DISABLE フラグと FILE_CACHE_MAX_HARD_ENABLE フラグは相互に排他的です。

FILE_CACHE_MAX_HARD_ENABLE
0x1
最大サイズ制限を有効にします。

FILE_CACHE_MAX_HARD_DISABLE フラグと FILE_CACHE_MAX_HARD_ENABLE フラグは相互に排他的です。

FILE_CACHE_MIN_HARD_DISABLE
0x8
最小サイズ制限を無効にします。

FILE_CACHE_MIN_HARD_DISABLE フラグと FILE_CACHE_MIN_HARD_ENABLE フラグは相互に排他的です。

FILE_CACHE_MIN_HARD_ENABLE
0x4
最小サイズ制限を有効にします。

FILE_CACHE_MIN_HARD_DISABLE フラグと FILE_CACHE_MIN_HARD_ENABLE フラグは相互に排他的です。

戻り値の型: BOOL

公式ドキュメント

ファイルシステムキャッシュのワーキングセットのサイズを制限します。

戻り値

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

関数が失敗した場合、戻り値は 0(ゼロ)になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

呼び出し元のプロセスは、SE_INCREASE_QUOTA_NAME 特権を有効にする必要があります。

MaximumFileCacheSize パラメーターを非常に小さい値に設定すると、システムパフォーマンスに悪影響を及ぼす可能性があります。

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

FILE_CACHE_* 定数は、Windows Server 2008 用 Windows SDK 以降の Windows ヘッダーファイルで定義されます。それ以前のバージョンの SDK のヘッダーファイルを使用している場合は、次の定義をコードに追加してください。

#ifndef FILE_CACHE_FLAGS_DEFINED

#define FILE_CACHE_MAX_HARD_ENABLE      0x00000001
#define FILE_CACHE_MAX_HARD_DISABLE     0x00000002
#define FILE_CACHE_MIN_HARD_ENABLE      0x00000004
#define FILE_CACHE_MIN_HARD_DISABLE     0x00000008

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

各言語での呼び出し定義

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

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

SetSystemFileCacheSize = ctypes.windll.kernel32.SetSystemFileCacheSize
SetSystemFileCacheSize.restype = wintypes.BOOL
SetSystemFileCacheSize.argtypes = [
    ctypes.c_size_t,  # MinimumFileCacheSize : UINT_PTR
    ctypes.c_size_t,  # MaximumFileCacheSize : UINT_PTR
    wintypes.DWORD,  # Flags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetSystemFileCacheSize = kernel32.NewProc("SetSystemFileCacheSize")
)

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

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

typedef SetSystemFileCacheSizeNative = Int32 Function(UintPtr, UintPtr, Uint32);
typedef SetSystemFileCacheSizeDart = int Function(int, int, int);
final SetSystemFileCacheSize = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetSystemFileCacheSizeNative, SetSystemFileCacheSizeDart>('SetSystemFileCacheSize');
// MinimumFileCacheSize : UINT_PTR -> UintPtr
// MaximumFileCacheSize : UINT_PTR -> UintPtr
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetSystemFileCacheSize(
  MinimumFileCacheSize: NativeUInt;   // UINT_PTR
  MaximumFileCacheSize: NativeUInt;   // UINT_PTR
  Flags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetSystemFileCacheSize';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetSystemFileCacheSize"
  c_SetSystemFileCacheSize :: CUIntPtr -> CUIntPtr -> Word32 -> IO CInt
-- MinimumFileCacheSize : UINT_PTR -> CUIntPtr
-- MaximumFileCacheSize : UINT_PTR -> CUIntPtr
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setsystemfilecachesize =
  foreign "SetSystemFileCacheSize"
    (size_t @-> size_t @-> uint32_t @-> returning int32_t)
(* MinimumFileCacheSize : UINT_PTR -> size_t *)
(* MaximumFileCacheSize : UINT_PTR -> size_t *)
(* Flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetSystemFileCacheSize" set-system-file-cache-size :convention :stdcall) :int32
  (minimum-file-cache-size :uint64)   ; UINT_PTR
  (maximum-file-cache-size :uint64)   ; UINT_PTR
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetSystemFileCacheSize = Win32::API::More->new('KERNEL32',
    'BOOL SetSystemFileCacheSize(WPARAM MinimumFileCacheSize, WPARAM MaximumFileCacheSize, DWORD Flags)');
# my $ret = $SetSystemFileCacheSize->Call($MinimumFileCacheSize, $MaximumFileCacheSize, $Flags);
# MinimumFileCacheSize : UINT_PTR -> WPARAM
# MaximumFileCacheSize : UINT_PTR -> WPARAM
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目