ホーム › System.ProcessStatus › K32GetWsChanges

K32GetWsChanges

関数

プロセスのワーキングセットのページフォルト情報を取得する。

DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL K32GetWsChanges(
    HANDLE hProcess,
    PSAPI_WS_WATCH_INFORMATION* lpWatchInfo,
    DWORD cb
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスへのハンドル。このハンドルは PROCESS_QUERY_INFORMATION アクセス権を持っている必要があります。詳細については、 Process Security and Access Rights を参照してください。
lpWatchInfo	PSAPI_WS_WATCH_INFORMATION*	out	ユーザーが割り当てたバッファーへのポインター。このバッファーは PSAPI_WS_WATCH_INFORMATION 構造体の配列を受け取ります。配列は、FaultingPc メンバーが NULL である構造体で終端されます。
cb	DWORD	in	lpWatchInfo バッファーのサイズ(バイト単位)。

戻り値の型: BOOL

公式ドキュメント

指定したプロセスのワーキングセットに対して、この関数または InitializeProcessForWsWatch 関数が最後に呼び出されて以降に追加されたページに関する情報を取得します。

戻り値

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

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

lpWatchInfo バッファーがすべてのワーキングセット変更レコードを格納するのに十分な大きさでない場合、 GetLastError は ERROR_INSUFFICIENT_BUFFER を返し、バッファーは空のまま返されます。より大きなメモリブロックをバッファー用に再割り当てし、再度呼び出してください。

解説(Remarks)

オペレーティングシステムは、ワーキングセット変更レコードを保持するためにプロセスごとに 1 つのバッファーを使用します。複数のアプリケーション(または同一アプリケーション内の複数のスレッド)が同じプロセスハンドルでこの関数を呼び出した場合、各呼び出しがバッファーを空にするため、いずれのアプリケーションもワーキングセットの変更を完全には把握できません。

オペレーティングシステムは、クエリの処理中(およびバッファーを空にしている間)は新しい変更レコードを記録しません。別のクエリの処理中に並行するクエリを受け取った場合、この関数はエラーコードを NO_MORE_ENTRIES に設定します。

バッファーがいっぱいになった場合、この関数または InitializeProcessForWsWatch 関数が呼び出されるまで、新しいレコードはバッファーに追加されません。データ損失の可能性を防ぐため、この関数を十分な頻度で呼び出してください。レコードが失われた場合、配列は FaultingPc メンバーが NULL で、FaultingVa メンバーに失われたレコード数が設定された構造体で終端されます。

Windows Server 2003 および Windows XP: レコードが失われた場合、配列は FaultingPc メンバーが NULL で、FaultingVa メンバーが 1 である構造体で終端されます。

Windows 7 および Windows Server 2008 R2 以降、Psapi.h は PSAPI 関数に対するバージョン番号を定義します。PSAPI のバージョン番号は、関数を呼び出すために使用する名前と、プログラムが読み込む必要のあるライブラリに影響します。

PSAPI_VERSION が 2 以上の場合、この関数は Psapi.h で K32GetWsChanges として定義され、Kernel32.lib および Kernel32.dll でエクスポートされます。PSAPI_VERSION が 1 の場合、この関数は Psapi.h で GetWsChanges として定義され、 K32GetWsChanges を呼び出すラッパーとして Psapi.lib および Psapi.dll でエクスポートされます。

以前のバージョンの Windows と Windows 7 以降のバージョンの両方で実行する必要があるプログラムは、常にこの関数を GetWsChanges として呼び出す必要があります。シンボルが正しく解決されるようにするには、 TARGETLIBS マクロに Psapi.lib を追加し、プログラムを -DPSAPI_VERSION=1 でコンパイルしてください。実行時の動的リンクを使用するには、Psapi.dll を読み込みます。

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

各言語での呼び出し定義

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

BOOL K32GetWsChanges(
    HANDLE hProcess,
    PSAPI_WS_WATCH_INFORMATION* lpWatchInfo,
    DWORD cb
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool K32GetWsChanges(
    IntPtr hProcess,   // HANDLE
    IntPtr lpWatchInfo,   // PSAPI_WS_WATCH_INFORMATION* out
    uint cb   // DWORD
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function K32GetWsChanges(
    hProcess As IntPtr,   ' HANDLE
    lpWatchInfo As IntPtr,   ' PSAPI_WS_WATCH_INFORMATION* out
    cb As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' lpWatchInfo : PSAPI_WS_WATCH_INFORMATION* out
' cb : DWORD
Declare PtrSafe Function K32GetWsChanges Lib "kernel32" ( _
    ByVal hProcess As LongPtr, _
    ByVal lpWatchInfo As LongPtr, _
    ByVal cb As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

K32GetWsChanges = ctypes.windll.kernel32.K32GetWsChanges
K32GetWsChanges.restype = wintypes.BOOL
K32GetWsChanges.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_void_p,  # lpWatchInfo : PSAPI_WS_WATCH_INFORMATION* out
    wintypes.DWORD,  # cb : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
K32GetWsChanges = Fiddle::Function.new(
  lib['K32GetWsChanges'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # lpWatchInfo : PSAPI_WS_WATCH_INFORMATION* out
    -Fiddle::TYPE_INT,  # cb : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn K32GetWsChanges(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        lpWatchInfo: *mut PSAPI_WS_WATCH_INFORMATION,  // PSAPI_WS_WATCH_INFORMATION* out
        cb: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool K32GetWsChanges(IntPtr hProcess, IntPtr lpWatchInfo, uint cb);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_K32GetWsChanges' -Namespace Win32 -PassThru
# $api::K32GetWsChanges(hProcess, lpWatchInfo, cb)

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

出力引数:

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