ホーム › System.Performance › PdhCalculateCounterFromRawValue

PdhCalculateCounterFromRawValue

関数

二つの生値からカウンター値を整形して算出する。

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

シグネチャ

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

DWORD PdhCalculateCounterFromRawValue(
    PDH_HCOUNTER hCounter,
    PDH_FMT dwFormat,
    PDH_RAW_COUNTER* rawValue1,
    PDH_RAW_COUNTER* rawValue2,
    PDH_FMT_COUNTERVALUE* fmtValue
);

パラメーター

名前

型

方向

説明

hCounter

PDH_HCOUNTER

計算対象のカウンターへのハンドルです。この関数は、カウンターの情報を使用して値の計算方法を決定します。このハンドルは PdhAddCounter 関数によって返されます。

dwFormat

PDH_FMT

計算結果のデータ型を指定します。次のいずれかの値を指定してください。

Value	Meaning
PDH_FMT_DOUBLE	計算結果を倍精度浮動小数点数として返します。
PDH_FMT_LARGE	計算結果を 64 ビット整数として返します。
PDH_FMT_LONG	計算結果を long 整数として返します。

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

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

rawValue1

PDH_RAW_COUNTER*

表示可能なカウンター値の計算に使用する生のカウンター値です。詳細については、PDH_RAW_COUNTER 構造体を参照してください。

rawValue2

PDH_RAW_COUNTER*

表示可能なカウンター値の計算に使用する生のカウンター値です。詳細については、PDH_RAW_COUNTER を参照してください。一部のカウンター (たとえばレートカウンターなど) では、表示可能な値を計算するために 2 つの生の値が必要です。カウンターの種類が 2 番目の値を必要としない場合は、このパラメーターに NULL を設定してください。この値は、2 つの生の値のうち古い方である必要があります。

fmtValue

PDH_FMT_COUNTERVALUE*

out

計算されたカウンター値を受け取る PDH_FMT_COUNTERVALUE 構造体です。

戻り値の型: DWORD

公式ドキュメント

2 つの生のカウンター値から、表示可能なカウンター値を計算します。

戻り値

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

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

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

解説(Remarks)

クエリから現在の生のカウンター値を取得するには、PdhGetRawCounterValue 関数を呼び出してください。

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

各言語での呼び出し定義

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

DWORD PdhCalculateCounterFromRawValue(
    PDH_HCOUNTER hCounter,
    PDH_FMT dwFormat,
    PDH_RAW_COUNTER* rawValue1,
    PDH_RAW_COUNTER* rawValue2,
    PDH_FMT_COUNTERVALUE* fmtValue
);

[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhCalculateCounterFromRawValue(
    IntPtr hCounter,   // PDH_HCOUNTER
    uint dwFormat,   // PDH_FMT
    IntPtr rawValue1,   // PDH_RAW_COUNTER*
    IntPtr rawValue2,   // PDH_RAW_COUNTER*
    IntPtr fmtValue   // PDH_FMT_COUNTERVALUE* out
);

<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhCalculateCounterFromRawValue(
    hCounter As IntPtr,   ' PDH_HCOUNTER
    dwFormat As UInteger,   ' PDH_FMT
    rawValue1 As IntPtr,   ' PDH_RAW_COUNTER*
    rawValue2 As IntPtr,   ' PDH_RAW_COUNTER*
    fmtValue As IntPtr   ' PDH_FMT_COUNTERVALUE* out
) As UInteger
End Function

' hCounter : PDH_HCOUNTER
' dwFormat : PDH_FMT
' rawValue1 : PDH_RAW_COUNTER*
' rawValue2 : PDH_RAW_COUNTER*
' fmtValue : PDH_FMT_COUNTERVALUE* out
Declare PtrSafe Function PdhCalculateCounterFromRawValue Lib "pdh" ( _
    ByVal hCounter As LongPtr, _
    ByVal dwFormat As Long, _
    ByVal rawValue1 As LongPtr, _
    ByVal rawValue2 As LongPtr, _
    ByVal fmtValue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhCalculateCounterFromRawValue = ctypes.windll.pdh.PdhCalculateCounterFromRawValue
PdhCalculateCounterFromRawValue.restype = wintypes.DWORD
PdhCalculateCounterFromRawValue.argtypes = [
    wintypes.HANDLE,  # hCounter : PDH_HCOUNTER
    wintypes.DWORD,  # dwFormat : PDH_FMT
    ctypes.c_void_p,  # rawValue1 : PDH_RAW_COUNTER*
    ctypes.c_void_p,  # rawValue2 : PDH_RAW_COUNTER*
    ctypes.c_void_p,  # fmtValue : PDH_FMT_COUNTERVALUE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhCalculateCounterFromRawValue = Fiddle::Function.new(
  lib['PdhCalculateCounterFromRawValue'],
  [
    Fiddle::TYPE_VOIDP,  # hCounter : PDH_HCOUNTER
    -Fiddle::TYPE_INT,  # dwFormat : PDH_FMT
    Fiddle::TYPE_VOIDP,  # rawValue1 : PDH_RAW_COUNTER*
    Fiddle::TYPE_VOIDP,  # rawValue2 : PDH_RAW_COUNTER*
    Fiddle::TYPE_VOIDP,  # fmtValue : PDH_FMT_COUNTERVALUE* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhCalculateCounterFromRawValue(
        hCounter: *mut core::ffi::c_void,  // PDH_HCOUNTER
        dwFormat: u32,  // PDH_FMT
        rawValue1: *mut PDH_RAW_COUNTER,  // PDH_RAW_COUNTER*
        rawValue2: *mut PDH_RAW_COUNTER,  // PDH_RAW_COUNTER*
        fmtValue: *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 PdhCalculateCounterFromRawValue(IntPtr hCounter, uint dwFormat, IntPtr rawValue1, IntPtr rawValue2, IntPtr fmtValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhCalculateCounterFromRawValue' -Namespace Win32 -PassThru
# $api::PdhCalculateCounterFromRawValue(hCounter, dwFormat, rawValue1, rawValue2, fmtValue)

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

出力引数:

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