ホーム › System.Performance › PdhComputeCounterStatistics

PdhComputeCounterStatistics

関数

生値配列からカウンターの統計情報を計算する。

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

シグネチャ

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

DWORD PdhComputeCounterStatistics(
    PDH_HCOUNTER hCounter,
    PDH_FMT dwFormat,
    DWORD dwFirstEntry,
    DWORD dwNumEntries,
    PDH_RAW_COUNTER* lpRawValueArray,
    PDH_STATISTICS* data
);

パラメーター

名前

型

方向

説明

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 倍します。

dwFirstEntry

DWORD

計算を開始する最初の生のカウンター値の、0 から始まるインデックス。このインデックス値はバッファー内の最も古いエントリを指している必要があります。関数はこのエントリから開始してバッファーをスキャンし、最後のエントリに達するとバッファーの先頭に折り返し、dwFirstEntry-1 のエントリまで処理します。このエントリが最も新しい、つまり最新のデータと見なされます。

dwNumEntries

DWORD

lpRawValueArray バッファー内の生のカウンター値の数。

lpRawValueArray

PDH_RAW_COUNTER*

dwNumEntries 個のエントリを含む PDH_RAW_COUNTER 構造体の配列。

data

PDH_STATISTICS*

out

カウンターの統計を受け取る PDH_STATISTICS 構造体。

戻り値の型: DWORD

公式ドキュメント

生の値の配列から、カウンターの統計を計算します。

戻り値

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

関数が失敗した場合は、戻り値はシステムエラーコードまたは PDH エラーコードです。次の値が返される可能性があります。

戻り値	説明
PDH_INVALID_ARGUMENT	引数が正しくないか、書式が正しくありません。
PDH_INVALID_HANDLE	カウンターハンドルが無効です。

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

各言語での呼び出し定義

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

DWORD PdhComputeCounterStatistics(
    PDH_HCOUNTER hCounter,
    PDH_FMT dwFormat,
    DWORD dwFirstEntry,
    DWORD dwNumEntries,
    PDH_RAW_COUNTER* lpRawValueArray,
    PDH_STATISTICS* data
);

[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhComputeCounterStatistics(
    IntPtr hCounter,   // PDH_HCOUNTER
    uint dwFormat,   // PDH_FMT
    uint dwFirstEntry,   // DWORD
    uint dwNumEntries,   // DWORD
    IntPtr lpRawValueArray,   // PDH_RAW_COUNTER*
    IntPtr data   // PDH_STATISTICS* out
);

<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhComputeCounterStatistics(
    hCounter As IntPtr,   ' PDH_HCOUNTER
    dwFormat As UInteger,   ' PDH_FMT
    dwFirstEntry As UInteger,   ' DWORD
    dwNumEntries As UInteger,   ' DWORD
    lpRawValueArray As IntPtr,   ' PDH_RAW_COUNTER*
    data As IntPtr   ' PDH_STATISTICS* out
) As UInteger
End Function

' hCounter : PDH_HCOUNTER
' dwFormat : PDH_FMT
' dwFirstEntry : DWORD
' dwNumEntries : DWORD
' lpRawValueArray : PDH_RAW_COUNTER*
' data : PDH_STATISTICS* out
Declare PtrSafe Function PdhComputeCounterStatistics Lib "pdh" ( _
    ByVal hCounter As LongPtr, _
    ByVal dwFormat As Long, _
    ByVal dwFirstEntry As Long, _
    ByVal dwNumEntries As Long, _
    ByVal lpRawValueArray As LongPtr, _
    ByVal data As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhComputeCounterStatistics = ctypes.windll.pdh.PdhComputeCounterStatistics
PdhComputeCounterStatistics.restype = wintypes.DWORD
PdhComputeCounterStatistics.argtypes = [
    wintypes.HANDLE,  # hCounter : PDH_HCOUNTER
    wintypes.DWORD,  # dwFormat : PDH_FMT
    wintypes.DWORD,  # dwFirstEntry : DWORD
    wintypes.DWORD,  # dwNumEntries : DWORD
    ctypes.c_void_p,  # lpRawValueArray : PDH_RAW_COUNTER*
    ctypes.c_void_p,  # data : PDH_STATISTICS* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhComputeCounterStatistics = Fiddle::Function.new(
  lib['PdhComputeCounterStatistics'],
  [
    Fiddle::TYPE_VOIDP,  # hCounter : PDH_HCOUNTER
    -Fiddle::TYPE_INT,  # dwFormat : PDH_FMT
    -Fiddle::TYPE_INT,  # dwFirstEntry : DWORD
    -Fiddle::TYPE_INT,  # dwNumEntries : DWORD
    Fiddle::TYPE_VOIDP,  # lpRawValueArray : PDH_RAW_COUNTER*
    Fiddle::TYPE_VOIDP,  # data : PDH_STATISTICS* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhComputeCounterStatistics(
        hCounter: *mut core::ffi::c_void,  // PDH_HCOUNTER
        dwFormat: u32,  // PDH_FMT
        dwFirstEntry: u32,  // DWORD
        dwNumEntries: u32,  // DWORD
        lpRawValueArray: *mut PDH_RAW_COUNTER,  // PDH_RAW_COUNTER*
        data: *mut PDH_STATISTICS  // PDH_STATISTICS* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll")]
public static extern uint PdhComputeCounterStatistics(IntPtr hCounter, uint dwFormat, uint dwFirstEntry, uint dwNumEntries, IntPtr lpRawValueArray, IntPtr data);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhComputeCounterStatistics' -Namespace Win32 -PassThru
# $api::PdhComputeCounterStatistics(hCounter, dwFormat, dwFirstEntry, dwNumEntries, lpRawValueArray, data)

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

出力引数:

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