ホーム › System.Performance › PdhGetFormattedCounterValue

PdhGetFormattedCounterValue

関数

カウンターの値を指定形式に整形して取得する。

DLLpdh.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD PdhGetFormattedCounterValue(
    PDH_HCOUNTER hCounter,
    PDH_FMT dwFormat,
    DWORD* lpdwType,   // optional
    PDH_FMT_COUNTERVALUE* pValue
);

パラメーター

名前

型

方向

説明

hCounter

PDH_HCOUNTER

表示可能な値を計算する対象のカウンターのハンドル。このハンドルは PdhAddCounter 関数が返します。

dwFormat

PDH_FMT

書式化される値のデータ型を決定します。次のいずれかの値を指定します。

値	意味
PDH_FMT_DOUBLE	データを倍精度浮動小数点の実数として返します。
PDH_FMT_LARGE	データを 64 ビット整数として返します。
PDH_FMT_LONG	データを long 整数として返します。

ビットごとの論理和演算子 (|) を使用して、データ型を次のいずれかのスケーリング係数と組み合わせることができます。

値	意味
PDH_FMT_NOSCALE	カウンターの既定のスケーリング係数を適用しません。
PDH_FMT_NOCAP100	100 を超えるカウンター値 (たとえばマルチプロセッサーコンピューターでプロセッサー負荷を測定するカウンター値など) が 100 にリセットされなくなります。既定の動作では、カウンター値は 100 を上限として制限されます。
PDH_FMT_1000	実際の値を 1,000 倍します。

lpdwType

DWORD*

outoptional

カウンターの種類を受け取ります。カウンターの種類の一覧については、Windows Server 2003 Deployment Kit の「Counter Types」セクションを参照してください。このパラメーターは省略可能です。

pValue

PDH_FMT_COUNTERVALUE*

out

カウンター値を受け取る PDH_FMT_COUNTERVALUE 構造体。

戻り値の型: DWORD

公式ドキュメント

指定したカウンターについて、表示可能な値を計算します。

戻り値

関数が成功した場合は、ERROR_SUCCESS を返します。

関数が失敗した場合、戻り値はシステムエラーコードまたは PDH エラーコードです。考えられる値は次のとおりです。

戻りコード	説明
PDH_INVALID_ARGUMENT	パラメーターが無効であるか、書式が正しくありません。
PDH_INVALID_DATA	指定したカウンターに有効なデータまたは成功を示すステータスコードが含まれていません。
PDH_INVALID_HANDLE	カウンターハンドルが無効です。

解説(Remarks)

呼び出しの処理中にデータが変更されるのを防ぐため、カウンターのデータは PdhGetFormattedCounterValue の呼び出し中ロック (保護) されます。データの読み取り (この関数の呼び出しが成功すること) により、カウンターのデータ変更フラグがクリアされます。

レートカウンターなど一部のカウンターでは、表示可能な値を計算するために 2 つのカウンター値が必要です。この場合、PdhGetFormattedCounterValue を呼び出す前に PdhCollectQueryData を 2 回呼び出す必要があります。詳細については、Collecting Performance Data を参照してください。

指定したカウンターインスタンスが存在しない場合、このメソッドは PDH_INVALID_DATA を返し、PDH_FMT_COUNTERVALUE 構造体の CStatus メンバーを PDH_CSTATUS_NO_INSTANCE に設定します。

Windows Server 2003 より前: インスタンスが見つからない場合、単一の値のみを必要とするカウンターに対して書式化の呼び出しが失敗することがあります。クエリと書式化の呼び出しを再度試みてください。2 回目も書式化の呼び出しが失敗する場合、そのインスタンスは見つかりません。あるいは、PdhEnumObjects 関数を refresh オプションを TRUE に設定して呼び出し、カウンターデータをクエリおよび書式化する前にカウンターインスタンスを更新することもできます。

例

例については、 Browsing Performance Counters または Reading Performance Data from a Log File を参照してください。

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

各言語での呼び出し定義

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

DWORD PdhGetFormattedCounterValue(
    PDH_HCOUNTER hCounter,
    PDH_FMT dwFormat,
    DWORD* lpdwType,   // optional
    PDH_FMT_COUNTERVALUE* pValue
);

[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhGetFormattedCounterValue(
    IntPtr hCounter,   // PDH_HCOUNTER
    uint dwFormat,   // PDH_FMT
    IntPtr lpdwType,   // DWORD* optional, out
    IntPtr pValue   // PDH_FMT_COUNTERVALUE* out
);

<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhGetFormattedCounterValue(
    hCounter As IntPtr,   ' PDH_HCOUNTER
    dwFormat As UInteger,   ' PDH_FMT
    lpdwType As IntPtr,   ' DWORD* optional, out
    pValue As IntPtr   ' PDH_FMT_COUNTERVALUE* out
) As UInteger
End Function

' hCounter : PDH_HCOUNTER
' dwFormat : PDH_FMT
' lpdwType : DWORD* optional, out
' pValue : PDH_FMT_COUNTERVALUE* out
Declare PtrSafe Function PdhGetFormattedCounterValue Lib "pdh" ( _
    ByVal hCounter As LongPtr, _
    ByVal dwFormat As Long, _
    ByVal lpdwType As LongPtr, _
    ByVal pValue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhGetFormattedCounterValue = ctypes.windll.pdh.PdhGetFormattedCounterValue
PdhGetFormattedCounterValue.restype = wintypes.DWORD
PdhGetFormattedCounterValue.argtypes = [
    wintypes.HANDLE,  # hCounter : PDH_HCOUNTER
    wintypes.DWORD,  # dwFormat : PDH_FMT
    ctypes.POINTER(wintypes.DWORD),  # lpdwType : DWORD* optional, out
    ctypes.c_void_p,  # pValue : PDH_FMT_COUNTERVALUE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhGetFormattedCounterValue = Fiddle::Function.new(
  lib['PdhGetFormattedCounterValue'],
  [
    Fiddle::TYPE_VOIDP,  # hCounter : PDH_HCOUNTER
    -Fiddle::TYPE_INT,  # dwFormat : PDH_FMT
    Fiddle::TYPE_VOIDP,  # lpdwType : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pValue : PDH_FMT_COUNTERVALUE* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhGetFormattedCounterValue(
        hCounter: *mut core::ffi::c_void,  // PDH_HCOUNTER
        dwFormat: u32,  // PDH_FMT
        lpdwType: *mut u32,  // DWORD* optional, out
        pValue: *mut PDH_FMT_COUNTERVALUE  // PDH_FMT_COUNTERVALUE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll")]
public static extern uint PdhGetFormattedCounterValue(IntPtr hCounter, uint dwFormat, IntPtr lpdwType, IntPtr pValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhGetFormattedCounterValue' -Namespace Win32 -PassThru
# $api::PdhGetFormattedCounterValue(hCounter, dwFormat, lpdwType, pValue)

#uselib "pdh.dll"
#func global PdhGetFormattedCounterValue "PdhGetFormattedCounterValue" sptr, sptr, sptr, sptr
; PdhGetFormattedCounterValue hCounter, dwFormat, varptr(lpdwType), varptr(pValue)   ; 戻り値は stat
; hCounter : PDH_HCOUNTER -> "sptr"
; dwFormat : PDH_FMT -> "sptr"
; lpdwType : DWORD* optional, out -> "sptr"
; pValue : PDH_FMT_COUNTERVALUE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "pdh.dll"
#cfunc global PdhGetFormattedCounterValue "PdhGetFormattedCounterValue" sptr, int, var, var
; res = PdhGetFormattedCounterValue(hCounter, dwFormat, lpdwType, pValue)
; hCounter : PDH_HCOUNTER -> "sptr"
; dwFormat : PDH_FMT -> "int"
; lpdwType : DWORD* optional, out -> "var"
; pValue : PDH_FMT_COUNTERVALUE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "pdh.dll"
#cfunc global PdhGetFormattedCounterValue "PdhGetFormattedCounterValue" sptr, int, sptr, sptr
; res = PdhGetFormattedCounterValue(hCounter, dwFormat, varptr(lpdwType), varptr(pValue))
; hCounter : PDH_HCOUNTER -> "sptr"
; dwFormat : PDH_FMT -> "int"
; lpdwType : DWORD* optional, out -> "sptr"
; pValue : PDH_FMT_COUNTERVALUE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。