ホーム › System.ProcessStatus › GetProcessMemoryInfo

GetProcessMemoryInfo

関数

指定プロセスのメモリ使用状況のカウンタを取得する。

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

シグネチャ

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

BOOL GetProcessMemoryInfo(
    HANDLE Process,
    PROCESS_MEMORY_COUNTERS* ppsmemCounters,
    DWORD cb
);

パラメーター

名前	型	方向	説明
Process	HANDLE	in	プロセスへのハンドル。このハンドルには PROCESS_QUERY_INFORMATION または PROCESS_QUERY_LIMITED_INFORMATION アクセス権が必要です。詳細については、Process Security and Access Rights を参照してください。 Windows Server 2003 および Windows XP: このハンドルには PROCESS_QUERY_INFORMATION および PROCESS_VM_READ アクセス権が必要です。
ppsmemCounters	PROCESS_MEMORY_COUNTERS*	out	プロセスのメモリ使用状況に関する情報を受け取る PROCESS_MEMORY_COUNTERS、PROCESS_MEMORY_COUNTERS_EX、または PROCESS_MEMORY_COUNTERS_EX2 構造体へのポインター。
cb	DWORD	in	ppsmemCounters 構造体のサイズ(バイト単位)。

名前

型

方向

説明

Process

HANDLE

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

Windows Server 2003 および Windows XP: このハンドルには PROCESS_QUERY_INFORMATION および PROCESS_VM_READ アクセス権が必要です。

ppsmemCounters

PROCESS_MEMORY_COUNTERS*

out

プロセスのメモリ使用状況に関する情報を受け取る PROCESS_MEMORY_COUNTERS、PROCESS_MEMORY_COUNTERS_EX、または PROCESS_MEMORY_COUNTERS_EX2 構造体へのポインター。

DWORD

ppsmemCounters 構造体のサイズ(バイト単位)。

戻り値の型: BOOL

公式ドキュメント

指定したプロセスのメモリ使用状況に関する情報を取得します。

戻り値

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

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

解説(Remarks)

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

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

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

例

例については、 Collecting Memory Usage Information for a Process を参照してください。

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

各言語での呼び出し定義

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

BOOL GetProcessMemoryInfo(
    HANDLE Process,
    PROCESS_MEMORY_COUNTERS* ppsmemCounters,
    DWORD cb
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("PSAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetProcessMemoryInfo(
    IntPtr Process,   // HANDLE
    IntPtr ppsmemCounters,   // PROCESS_MEMORY_COUNTERS* out
    uint cb   // DWORD
);

<DllImport("PSAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetProcessMemoryInfo(
    Process As IntPtr,   ' HANDLE
    ppsmemCounters As IntPtr,   ' PROCESS_MEMORY_COUNTERS* out
    cb As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Process : HANDLE
' ppsmemCounters : PROCESS_MEMORY_COUNTERS* out
' cb : DWORD
Declare PtrSafe Function GetProcessMemoryInfo Lib "psapi" ( _
    ByVal Process As LongPtr, _
    ByVal ppsmemCounters 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

GetProcessMemoryInfo = ctypes.windll.psapi.GetProcessMemoryInfo
GetProcessMemoryInfo.restype = wintypes.BOOL
GetProcessMemoryInfo.argtypes = [
    wintypes.HANDLE,  # Process : HANDLE
    ctypes.c_void_p,  # ppsmemCounters : PROCESS_MEMORY_COUNTERS* out
    wintypes.DWORD,  # cb : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PSAPI.dll')
GetProcessMemoryInfo = Fiddle::Function.new(
  lib['GetProcessMemoryInfo'],
  [
    Fiddle::TYPE_VOIDP,  # Process : HANDLE
    Fiddle::TYPE_VOIDP,  # ppsmemCounters : PROCESS_MEMORY_COUNTERS* out
    -Fiddle::TYPE_INT,  # cb : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "psapi")]
extern "system" {
    fn GetProcessMemoryInfo(
        Process: *mut core::ffi::c_void,  // HANDLE
        ppsmemCounters: *mut PROCESS_MEMORY_COUNTERS,  // PROCESS_MEMORY_COUNTERS* out
        cb: u32  // DWORD
    ) -> 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 GetProcessMemoryInfo(IntPtr Process, IntPtr ppsmemCounters, uint cb);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PSAPI_GetProcessMemoryInfo' -Namespace Win32 -PassThru
# $api::GetProcessMemoryInfo(Process, ppsmemCounters, cb)

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

出力引数:

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