ホーム › System.Performance › PdhFormatFromRawValue

PdhFormatFromRawValue

関数

二つの生値からカウンター値を指定形式に整形する。

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

シグネチャ

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

DWORD PdhFormatFromRawValue(
    DWORD dwCounterType,
    PDH_FMT dwFormat,
    LONGLONG* pTimeBase,   // optional
    PDH_RAW_COUNTER* pRawValue1,
    PDH_RAW_COUNTER* pRawValue2,
    PDH_FMT_COUNTERVALUE* pFmtValue
);

パラメーター

名前

型

方向

説明

dwCounterType

DWORD

カウンターの種類。通常は、生のカウンター値を取得するために PdhGetRawCounterValue を呼び出すのと同じタイミングで、PdhGetCounterInfo を呼び出してカウンターの種類を取得します。

カウンターの種類の一覧については、Windows Server 2003 Deployment Kit の「Counter Types」セクションを参照してください。(定数値は Winperf.h で定義されています。)

PERF_LARGE_RAW_BASE などの基本型は指定できないことに注意してください。

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

pTimeBase

LONGLONG*

inoptional

形式変換に必要な場合の、タイムベースへのポインター。形式変換にタイムベース情報が不要な場合、このパラメーターの値は無視されます。カウンターのタイムベースを取得するには、PdhGetCounterTimeBase を呼び出します。

pRawValue1

PDH_RAW_COUNTER*

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

pRawValue2

PDH_RAW_COUNTER*

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

pFmtValue

PDH_FMT_COUNTERVALUE*

out

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

戻り値の型: DWORD

公式ドキュメント

指定された生のカウンター値から、表示可能な値を計算します。

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードまたは PDH エラーコードです。

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

各言語での呼び出し定義

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

DWORD PdhFormatFromRawValue(
    DWORD dwCounterType,
    PDH_FMT dwFormat,
    LONGLONG* pTimeBase,   // optional
    PDH_RAW_COUNTER* pRawValue1,
    PDH_RAW_COUNTER* pRawValue2,
    PDH_FMT_COUNTERVALUE* pFmtValue
);

[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhFormatFromRawValue(
    uint dwCounterType,   // DWORD
    uint dwFormat,   // PDH_FMT
    IntPtr pTimeBase,   // LONGLONG* optional
    IntPtr pRawValue1,   // PDH_RAW_COUNTER*
    IntPtr pRawValue2,   // PDH_RAW_COUNTER*
    IntPtr pFmtValue   // PDH_FMT_COUNTERVALUE* out
);

<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhFormatFromRawValue(
    dwCounterType As UInteger,   ' DWORD
    dwFormat As UInteger,   ' PDH_FMT
    pTimeBase As IntPtr,   ' LONGLONG* optional
    pRawValue1 As IntPtr,   ' PDH_RAW_COUNTER*
    pRawValue2 As IntPtr,   ' PDH_RAW_COUNTER*
    pFmtValue As IntPtr   ' PDH_FMT_COUNTERVALUE* out
) As UInteger
End Function

' dwCounterType : DWORD
' dwFormat : PDH_FMT
' pTimeBase : LONGLONG* optional
' pRawValue1 : PDH_RAW_COUNTER*
' pRawValue2 : PDH_RAW_COUNTER*
' pFmtValue : PDH_FMT_COUNTERVALUE* out
Declare PtrSafe Function PdhFormatFromRawValue Lib "pdh" ( _
    ByVal dwCounterType As Long, _
    ByVal dwFormat As Long, _
    ByVal pTimeBase As LongPtr, _
    ByVal pRawValue1 As LongPtr, _
    ByVal pRawValue2 As LongPtr, _
    ByVal pFmtValue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhFormatFromRawValue = ctypes.windll.pdh.PdhFormatFromRawValue
PdhFormatFromRawValue.restype = wintypes.DWORD
PdhFormatFromRawValue.argtypes = [
    wintypes.DWORD,  # dwCounterType : DWORD
    wintypes.DWORD,  # dwFormat : PDH_FMT
    ctypes.POINTER(ctypes.c_longlong),  # pTimeBase : LONGLONG* optional
    ctypes.c_void_p,  # pRawValue1 : PDH_RAW_COUNTER*
    ctypes.c_void_p,  # pRawValue2 : PDH_RAW_COUNTER*
    ctypes.c_void_p,  # pFmtValue : PDH_FMT_COUNTERVALUE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhFormatFromRawValue = Fiddle::Function.new(
  lib['PdhFormatFromRawValue'],
  [
    -Fiddle::TYPE_INT,  # dwCounterType : DWORD
    -Fiddle::TYPE_INT,  # dwFormat : PDH_FMT
    Fiddle::TYPE_VOIDP,  # pTimeBase : LONGLONG* optional
    Fiddle::TYPE_VOIDP,  # pRawValue1 : PDH_RAW_COUNTER*
    Fiddle::TYPE_VOIDP,  # pRawValue2 : PDH_RAW_COUNTER*
    Fiddle::TYPE_VOIDP,  # pFmtValue : PDH_FMT_COUNTERVALUE* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhFormatFromRawValue(
        dwCounterType: u32,  // DWORD
        dwFormat: u32,  // PDH_FMT
        pTimeBase: *mut i64,  // LONGLONG* optional
        pRawValue1: *mut PDH_RAW_COUNTER,  // PDH_RAW_COUNTER*
        pRawValue2: *mut PDH_RAW_COUNTER,  // PDH_RAW_COUNTER*
        pFmtValue: *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 PdhFormatFromRawValue(uint dwCounterType, uint dwFormat, IntPtr pTimeBase, IntPtr pRawValue1, IntPtr pRawValue2, IntPtr pFmtValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhFormatFromRawValue' -Namespace Win32 -PassThru
# $api::PdhFormatFromRawValue(dwCounterType, dwFormat, pTimeBase, pRawValue1, pRawValue2, pFmtValue)

#uselib "pdh.dll"
#func global PdhFormatFromRawValue "PdhFormatFromRawValue" sptr, sptr, sptr, sptr, sptr, sptr
; PdhFormatFromRawValue dwCounterType, dwFormat, varptr(pTimeBase), varptr(pRawValue1), varptr(pRawValue2), varptr(pFmtValue)   ; 戻り値は stat
; dwCounterType : DWORD -> "sptr"
; dwFormat : PDH_FMT -> "sptr"
; pTimeBase : LONGLONG* optional -> "sptr"
; pRawValue1 : PDH_RAW_COUNTER* -> "sptr"
; pRawValue2 : PDH_RAW_COUNTER* -> "sptr"
; pFmtValue : PDH_FMT_COUNTERVALUE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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