<Return[PQ]><Top>

PdhGetFormattedCounterArray

Declare Sub Api_PdhGetFormattedCounterArray Lib "pdh" Alias "PdhGetFormattedCounterArray" (ByRef hCounter As hCounter, ByVal dwFormat&, ByRef lpdwBufferSize&, ByRef lpdwItemCount&, ByRef ItemBuffer As PPDH_FMT_COUNTERVALUE_ITEM_A)

Declare Sub PdhGetFormattedCounterArray Lib "pdh" (ByRef hCounter As hCounter, ByVal dwFormat As Long, ByRef lpdwBufferSize As Long, ByRef lpdwItemCount As Long, ByRef ItemBuffer As PPDH_FMT_COUNTERVALUE_ITEM_A)

カウンタの値の配列を特定の形式で取得する。

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

    値                                 

意味                                                          

    PDH_FMT_DOUBLE

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

    PDH_FMT_LARGE

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

    PDH_FMT_LONG

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

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

    値                                

意味                                           

    PDH_FMT_NOSCALE

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

    PDH_FMT_1000

実際の値に 1000 を掛ける。

lpdwBufferSize
    ItemBuffer パラメータが指すバッファのサイズ(バイト数)を指定する。
lpdwBufferCount
    ItemBuffer パラメータが指すバッファに格納されたカウンタ値の数を受け取る変数へのポインタを指定する。

ItemBuffer
    カウンタ値を受け取るデータバッファへのポインタを指定する。

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

    エラー値                                    

説明                                                            

    PDH_INVALID_ARGUMENT

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

    PDH_INVALID_HANDLE

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

 

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

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