ホーム › System.ProcessStatus › GetPerformanceInfo

GetPerformanceInfo

関数

システム全体のパフォーマンス情報を取得する。

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

シグネチャ

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

BOOL GetPerformanceInfo(
    PERFORMANCE_INFORMATION* pPerformanceInformation,
    DWORD cb
);

パラメーター

名前	型	方向	説明
pPerformanceInformation	PERFORMANCE_INFORMATION*	inout	パフォーマンス情報を受け取る PERFORMANCE_INFORMATION 構造体へのポインターです。
cb	DWORD	in	`<a href="/windows/desktop/api/psapi/ns-psapi-performance_information">PERFORMANCE_INFORMATION</a> 構造体のサイズ(バイト単位)です。`

戻り値の型: BOOL

公式ドキュメント

PERFORMANCE_INFORMATION 構造体に格納されたパフォーマンス値を取得します。

戻り値

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

解説(Remarks)

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

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

Windows 7 以降のバージョンに加えて、それ以前のバージョンの Windows でも実行する必要があるプログラムは、この関数を常に GetPerformanceInfo として呼び出してください。シンボルが正しく解決されるようにするには、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 GetPerformanceInfo(
    PERFORMANCE_INFORMATION* pPerformanceInformation,
    DWORD cb
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("PSAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetPerformanceInfo(
    IntPtr pPerformanceInformation,   // PERFORMANCE_INFORMATION* in/out
    uint cb   // DWORD
);

<DllImport("PSAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetPerformanceInfo(
    pPerformanceInformation As IntPtr,   ' PERFORMANCE_INFORMATION* in/out
    cb As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pPerformanceInformation : PERFORMANCE_INFORMATION* in/out
' cb : DWORD
Declare PtrSafe Function GetPerformanceInfo Lib "psapi" ( _
    ByVal pPerformanceInformation 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

GetPerformanceInfo = ctypes.windll.psapi.GetPerformanceInfo
GetPerformanceInfo.restype = wintypes.BOOL
GetPerformanceInfo.argtypes = [
    ctypes.c_void_p,  # pPerformanceInformation : PERFORMANCE_INFORMATION* in/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')
GetPerformanceInfo = Fiddle::Function.new(
  lib['GetPerformanceInfo'],
  [
    Fiddle::TYPE_VOIDP,  # pPerformanceInformation : PERFORMANCE_INFORMATION* in/out
    -Fiddle::TYPE_INT,  # cb : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "psapi")]
extern "system" {
    fn GetPerformanceInfo(
        pPerformanceInformation: *mut PERFORMANCE_INFORMATION,  // PERFORMANCE_INFORMATION* in/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 GetPerformanceInfo(IntPtr pPerformanceInformation, uint cb);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PSAPI_GetPerformanceInfo' -Namespace Win32 -PassThru
# $api::GetPerformanceInfo(pPerformanceInformation, cb)

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

出力引数:

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