<Return[PQ]><Top>

PdhGetCounterInfo

Declare Sub Api_PdhGetCounterInfo Lib "pdh" Alias "PdhGetCounterInfo" (ByRef hCounter As hCounter, ByVal bRetrieveExplainText&, ByRef pdwBufferSize&, ByRef lpBuffer As PPDH_COUNTER_INFO_A)

Declare Sub PdhGetCounterInfo Lib "pdh" (ByRef hCounter As hCounter, ByVal bRetrieveExplainText As Long, ByRef pdwBufferSize As Long, ByRef lpBuffer As PPDH_COUNTER_INFO_A)

カウンタの情報を取得する。カウンタの情報には、データのサイズ、カウンタの種類、パス、ユーザーが指定した値などが含まれる。

パラメータ
hCounter
    情報を取得するカウンタのハンドルを指定する。
bRetrieveExplainText
    説明のテキストを取得するかどうか指定する。TRUE に設定すると、カウンタの説明テキストを受け取る。FALSE に設定すると、バッファの

    該当するフィールドが NULL になる。
pdwBufferSize
    DWORD 変数へのポインタを指定する。この変数は、lpBuffer パラメータが指すバッファのサイズ(バイト数)に設定しておく。カウンタの情報

    を格納するために、pdwBufferSize パラメータが指すサイズより大きいバッファが必要な場合は、この変数が必要なバッファサイズに設定され

    る。関数が成功すると、バッファに格納されたデータのサイズに設定される。0 に設定して関数を呼び出すと、バッファにデータは格納されず

    に(実際、lpBuffer パラメータに NULL を指定できる)、この変数がデータの格納に必要なサイズ(バイト数)に設定される。
lpBuffer
    カウンタの情報を受け取るデータバッファへのポインタを指定する。構造体の固定長部分の後ろに文字列データが付加されるため、受け取る

    データは可変長である。これは、呼び出し側が確保した 1 つのバッファでデータのすべてを受け取るためである。

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

    エラ値                                       

説明                                                          

    PDH_INVALID_ARGUMENT

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

    PDH_INVALID_HANDLE

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

    PDH_MORE_DATA

用意したバッファのサイズが不十分で、要求したデータを受け取ることができない。