ホーム › System.ProcessStatus › GetWsChangesEx

GetWsChangesEx

関数

ワーキングセットのページフォルト情報を拡張形式で取得する。

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

シグネチャ

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

BOOL GetWsChangesEx(
    HANDLE hProcess,
    PSAPI_WS_WATCH_INFORMATION_EX* lpWatchInfoEx,
    DWORD* cb
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

指定したプロセスのワーキングセットに、この関数または InitializeProcessForWsWatch 関数が前回呼び出されてから追加されたページに関する拡張情報を取得します。

戻り値

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

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

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

解説(Remarks)

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

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

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

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

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

以前のバージョンの Windows と Windows 7 以降の両方で動作する必要があるプログラムは、常にこの関数を GetWsChangesEx として呼び出してください。シンボルが正しく解決されるようにするには、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)

各言語での呼び出し定義

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

BOOL GetWsChangesEx(
    HANDLE hProcess,
    PSAPI_WS_WATCH_INFORMATION_EX* lpWatchInfoEx,
    DWORD* cb
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("PSAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetWsChangesEx(
    IntPtr hProcess,   // HANDLE
    IntPtr lpWatchInfoEx,   // PSAPI_WS_WATCH_INFORMATION_EX* out
    ref uint cb   // DWORD* in/out
);

<DllImport("PSAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetWsChangesEx(
    hProcess As IntPtr,   ' HANDLE
    lpWatchInfoEx As IntPtr,   ' PSAPI_WS_WATCH_INFORMATION_EX* out
    ByRef cb As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' lpWatchInfoEx : PSAPI_WS_WATCH_INFORMATION_EX* out
' cb : DWORD* in/out
Declare PtrSafe Function GetWsChangesEx Lib "psapi" ( _
    ByVal hProcess As LongPtr, _
    ByVal lpWatchInfoEx As LongPtr, _
    ByRef cb As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetWsChangesEx = ctypes.windll.psapi.GetWsChangesEx
GetWsChangesEx.restype = wintypes.BOOL
GetWsChangesEx.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_void_p,  # lpWatchInfoEx : PSAPI_WS_WATCH_INFORMATION_EX* out
    ctypes.POINTER(wintypes.DWORD),  # cb : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PSAPI.dll')
GetWsChangesEx = Fiddle::Function.new(
  lib['GetWsChangesEx'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # lpWatchInfoEx : PSAPI_WS_WATCH_INFORMATION_EX* out
    Fiddle::TYPE_VOIDP,  # cb : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("PSAPI.dll", SetLastError = true)]
public static extern bool GetWsChangesEx(IntPtr hProcess, IntPtr lpWatchInfoEx, ref uint cb);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PSAPI_GetWsChangesEx' -Namespace Win32 -PassThru
# $api::GetWsChangesEx(hProcess, lpWatchInfoEx, cb)

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

出力引数:

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