<Return[PQ]><Top>

PdhGetFormattedCounterValue

Declare Sub Api_PdhGetFormattedCounterValue Lib "pdh" Alias "PdhGetFormattedCounterValue" (ByRef hCounter As hCounter, ByVal dwFormat&, ByRef lpdwType&, ByRef pValue As PPDH_FMT_COUNTERVALUE)

Declare Sub PdhGetFormattedCounterValue Lib "pdh" (ByRef hCounter As hCounter, ByVal dwFormat As Long, ByRef lpdwType As Long, ByRef pValue As PPDH_FMT_COUNTERVALUE)

指定したカウンタの現在の値を特定の形式で取得する。

パラメータ
hCounter
    カウンタのハンドルを指定する。このカウンタの現在の値を特定の形式で取得する。
dwFormat
    取得するデータの形式を指定する。次のいずれかの値を指定する。 

    値                                 

意味                                                          

    PDH_FMT_DOUBLE

データを倍精度浮動小数点実数で取得する。

    PDH_FMT_LARGE

データを 64 ビット整数で取得する。

    PDH_FMT_LONG

データを長整数で取得する。

    前記で選択した値と次のいずれかのスケールフラグを OR 演算子で結合できる。

    フラグ                             

意味                                           

    PDH_FMT_NOSCALE

計算で既定のスケールを使わない。

    PDH_FMT_1000

実際の値に 1000 を掛ける。

lpdwType
    カウンタの種類を受け取る DWORD バッファへのポインタを指定する。このバッファが受け取るカウンタの種類については、WINPERF.H ヘ

    ッダーファイルを参照する。このパラメータは省略可能である。
pValue
    カウンタの値を受け取るデータバッファへのポインタを指定する。

戻り値
    関数が成功すると、ERROR_SUCCESS が返る。
    関数が失敗すると、PDHMSG.H ヘッダーファイルで定義されている PDH エラーステータスが返る。次のいずれかの値が返る。

    エラー値                                    

説明                                                                                         

    PDH_INVALID_ARGUMENT

引数が正しくないか、引数の形式が正しくない。

    PDH_INVALID_DATA

指定したカウンタには、有効なデータも成功を示す状態コードもない。

    PDH_INVALID_HANDLE

カウンタのハンドルが無効である。

　

解説
    PdhGetFormattedCounterValue 関数を呼び出している間はカウンタのデータがロック(保護)され、関数の処理中にデータが変更されるのを

    防ぐ。この関数が成功し、データが読み取られると、カウンタのデータ変更済みフラグがクリアされる。