ホーム › System.Memory › GetSystemFileCacheSize

GetSystemFileCacheSize

関数

システムファイルキャッシュの最小・最大サイズを取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetSystemFileCacheSize(
    UINT_PTR* lpMinimumFileCacheSize,
    UINT_PTR* lpMaximumFileCacheSize,
    DWORD* lpFlags
);

パラメーター

名前

型

方向

説明

lpMinimumFileCacheSize

UINT_PTR*

out

ファイルキャッシュの最小サイズ(バイト単位)を受け取る変数へのポインター。FILE_CACHE_MIN_HARD_ENABLE フラグを指定した SetSystemFileCacheSize 関数の呼び出しが事前に行われている場合、仮想メモリマネージャーは少なくともこのサイズ分のメモリをシステムファイルキャッシュ内に常駐させようとします。

lpMaximumFileCacheSize

UINT_PTR*

out

ファイルキャッシュの最大サイズ(バイト単位)を受け取る変数へのポインター。仮想メモリマネージャーは、FILE_CACHE_MAX_HARD_ENABLE フラグを指定した SetSystemFileCacheSize の呼び出しが事前に行われている場合にのみ、この制限を適用します。

lpFlags

DWORD*

out

どのファイルキャッシュ制限が有効になっているかを示すフラグ。

値	意味
FILE_CACHE_MAX_HARD_ENABLE 0x1	最大サイズ制限が有効です。このフラグが存在しない場合、この制限は無効になります。
FILE_CACHE_MIN_HARD_ENABLE 0x4	最小サイズ制限が有効です。このフラグが存在しない場合、この制限は無効になります。

戻り値の型: BOOL

公式ドキュメント

システムキャッシュのワーキングセットに対する現在のサイズ制限を取得します。

戻り値

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

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

解説(Remarks)

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

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

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

各言語での呼び出し定義

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

BOOL GetSystemFileCacheSize(
    UINT_PTR* lpMinimumFileCacheSize,
    UINT_PTR* lpMaximumFileCacheSize,
    DWORD* lpFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetSystemFileCacheSize(
    out UIntPtr lpMinimumFileCacheSize,   // UINT_PTR* out
    out UIntPtr lpMaximumFileCacheSize,   // UINT_PTR* out
    out uint lpFlags   // DWORD* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetSystemFileCacheSize(
    <Out> ByRef lpMinimumFileCacheSize As UIntPtr,   ' UINT_PTR* out
    <Out> ByRef lpMaximumFileCacheSize As UIntPtr,   ' UINT_PTR* out
    <Out> ByRef lpFlags As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpMinimumFileCacheSize : UINT_PTR* out
' lpMaximumFileCacheSize : UINT_PTR* out
' lpFlags : DWORD* out
Declare PtrSafe Function GetSystemFileCacheSize Lib "kernel32" ( _
    ByRef lpMinimumFileCacheSize As LongPtr, _
    ByRef lpMaximumFileCacheSize As LongPtr, _
    ByRef lpFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetSystemFileCacheSize = ctypes.windll.kernel32.GetSystemFileCacheSize
GetSystemFileCacheSize.restype = wintypes.BOOL
GetSystemFileCacheSize.argtypes = [
    ctypes.POINTER(ctypes.c_size_t),  # lpMinimumFileCacheSize : UINT_PTR* out
    ctypes.POINTER(ctypes.c_size_t),  # lpMaximumFileCacheSize : UINT_PTR* out
    ctypes.POINTER(wintypes.DWORD),  # lpFlags : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetSystemFileCacheSize = Fiddle::Function.new(
  lib['GetSystemFileCacheSize'],
  [
    Fiddle::TYPE_VOIDP,  # lpMinimumFileCacheSize : UINT_PTR* out
    Fiddle::TYPE_VOIDP,  # lpMaximumFileCacheSize : UINT_PTR* out
    Fiddle::TYPE_VOIDP,  # lpFlags : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetSystemFileCacheSize(
        lpMinimumFileCacheSize: *mut usize,  // UINT_PTR* out
        lpMaximumFileCacheSize: *mut usize,  // UINT_PTR* out
        lpFlags: *mut u32  // DWORD* out
    ) -> 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 GetSystemFileCacheSize(out UIntPtr lpMinimumFileCacheSize, out UIntPtr lpMaximumFileCacheSize, out uint lpFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetSystemFileCacheSize' -Namespace Win32 -PassThru
# $api::GetSystemFileCacheSize(lpMinimumFileCacheSize, lpMaximumFileCacheSize, lpFlags)

#uselib "KERNEL32.dll"
#func global GetSystemFileCacheSize "GetSystemFileCacheSize" sptr, sptr, sptr
; GetSystemFileCacheSize varptr(lpMinimumFileCacheSize), varptr(lpMaximumFileCacheSize), varptr(lpFlags)   ; 戻り値は stat
; lpMinimumFileCacheSize : UINT_PTR* out -> "sptr"
; lpMaximumFileCacheSize : UINT_PTR* out -> "sptr"
; lpFlags : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetSystemFileCacheSize "GetSystemFileCacheSize" var, var, var
; res = GetSystemFileCacheSize(lpMinimumFileCacheSize, lpMaximumFileCacheSize, lpFlags)
; lpMinimumFileCacheSize : UINT_PTR* out -> "var"
; lpMaximumFileCacheSize : UINT_PTR* out -> "var"
; lpFlags : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetSystemFileCacheSize "GetSystemFileCacheSize" sptr, sptr, sptr
; res = GetSystemFileCacheSize(varptr(lpMinimumFileCacheSize), varptr(lpMaximumFileCacheSize), varptr(lpFlags))
; lpMinimumFileCacheSize : UINT_PTR* out -> "sptr"
; lpMaximumFileCacheSize : UINT_PTR* out -> "sptr"
; lpFlags : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。