ホーム › System.Performance › PdhGetCounterInfoA

PdhGetCounterInfoA

関数

カウンターの構成情報と説明文を取得する(ANSI版)。

DLLpdh.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhGetCounterInfoA(
    PDH_HCOUNTER hCounter,
    BOOLEAN bRetrieveExplainText,
    DWORD* pdwBufferSize,
    PDH_COUNTER_INFO_A* lpBuffer   // optional
);

パラメーター

名前	型	方向	説明
hCounter	PDH_HCOUNTER	in	情報を取得する対象のカウンターのハンドル。このハンドルは PdhAddCounter 関数から返されます。
bRetrieveExplainText	BOOLEAN	in	説明テキスト(explain text)を取得するかどうかを指定します。このパラメーターを TRUE に設定すると、カウンターの説明テキストが取得されます。FALSE に設定すると、返されるバッファー内の該当フィールドは NULL になります。
pdwBufferSize	DWORD*	inout	lpBuffer バッファーのサイズ(バイト単位)。入力時に 0 を指定した場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数は実際に使用されたバッファーサイズをこのパラメーターに設定します。入力時に指定したサイズが 0 より大きいものの必要なサイズに満たない場合は、返されたサイズに基づいてバッファーを再割り当てしないでください。
lpBuffer	PDH_COUNTER_INFO_A*	outoptional	PDH_COUNTER_INFO 構造体を受け取る、呼び出し元が割り当てたバッファー。この構造体は可変長です。文字列データが固定長部分の末尾に追加されるためです。これにより、すべてのデータが呼び出し元の割り当てた単一のバッファーに返されます。pdwBufferSize が 0 の場合は NULL を設定します。

戻り値の型: DWORD

公式ドキュメント

カウンターに関する情報(データサイズ、カウンターの種類、パス、ユーザー指定のデータ値など)を取得します。(ANSI)

戻り値

関数が成功すると、ERROR_SUCCESS を返します。

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

戻り値	説明
PDH_INVALID_ARGUMENT	パラメーターが無効であるか、形式が正しくありません。たとえば、一部のリリースでは、入力時に指定したサイズが 0 より大きいものの必要なサイズに満たない場合にこのエラーが返されることがあります。
PDH_INVALID_HANDLE	カウンターハンドルが無効です。
PDH_MORE_DATA	lpBuffer バッファーが小さすぎてカウンター情報を格納できません。この戻り値は、入力時に pdwBufferSize が 0 の場合に想定されます。入力時に指定したサイズが 0 より大きいものの必要なサイズに満たない場合は、返されたサイズに基づいてバッファーを再割り当てしないでください。

解説(Remarks)

この関数は 2 回呼び出す必要があります。1 回目は必要なバッファーサイズを取得するため(lpBuffer を NULL、pdwBufferSize を 0 に設定)、2 回目はデータを取得するためです。

メモ

pdh.h ヘッダーでは、PdhGetCounterInfo がエイリアスとして定義されており、UNICODE プリプロセッサー定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコード非依存のエイリアスを、エンコード非依存でないコードと混在して使用すると、不整合が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhGetCounterInfoA(
    PDH_HCOUNTER hCounter,
    BOOLEAN bRetrieveExplainText,
    DWORD* pdwBufferSize,
    PDH_COUNTER_INFO_A* lpBuffer   // optional
);

[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhGetCounterInfoA(
    IntPtr hCounter,   // PDH_HCOUNTER
    [MarshalAs(UnmanagedType.U1)] bool bRetrieveExplainText,   // BOOLEAN
    ref uint pdwBufferSize,   // DWORD* in/out
    IntPtr lpBuffer   // PDH_COUNTER_INFO_A* optional, out
);

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhGetCounterInfoA(
    hCounter As IntPtr,   ' PDH_HCOUNTER
    <MarshalAs(UnmanagedType.U1)> bRetrieveExplainText As Boolean,   ' BOOLEAN
    ByRef pdwBufferSize As UInteger,   ' DWORD* in/out
    lpBuffer As IntPtr   ' PDH_COUNTER_INFO_A* optional, out
) As UInteger
End Function

' hCounter : PDH_HCOUNTER
' bRetrieveExplainText : BOOLEAN
' pdwBufferSize : DWORD* in/out
' lpBuffer : PDH_COUNTER_INFO_A* optional, out
Declare PtrSafe Function PdhGetCounterInfoA Lib "pdh" ( _
    ByVal hCounter As LongPtr, _
    ByVal bRetrieveExplainText As Byte, _
    ByRef pdwBufferSize As Long, _
    ByVal lpBuffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhGetCounterInfoA = ctypes.windll.pdh.PdhGetCounterInfoA
PdhGetCounterInfoA.restype = wintypes.DWORD
PdhGetCounterInfoA.argtypes = [
    wintypes.HANDLE,  # hCounter : PDH_HCOUNTER
    wintypes.BOOLEAN,  # bRetrieveExplainText : BOOLEAN
    ctypes.POINTER(wintypes.DWORD),  # pdwBufferSize : DWORD* in/out
    ctypes.c_void_p,  # lpBuffer : PDH_COUNTER_INFO_A* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhGetCounterInfoA = Fiddle::Function.new(
  lib['PdhGetCounterInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # hCounter : PDH_HCOUNTER
    Fiddle::TYPE_CHAR,  # bRetrieveExplainText : BOOLEAN
    Fiddle::TYPE_VOIDP,  # pdwBufferSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpBuffer : PDH_COUNTER_INFO_A* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhGetCounterInfoA(
        hCounter: *mut core::ffi::c_void,  // PDH_HCOUNTER
        bRetrieveExplainText: u8,  // BOOLEAN
        pdwBufferSize: *mut u32,  // DWORD* in/out
        lpBuffer: *mut PDH_COUNTER_INFO_A  // PDH_COUNTER_INFO_A* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Ansi)]
public static extern uint PdhGetCounterInfoA(IntPtr hCounter, [MarshalAs(UnmanagedType.U1)] bool bRetrieveExplainText, ref uint pdwBufferSize, IntPtr lpBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhGetCounterInfoA' -Namespace Win32 -PassThru
# $api::PdhGetCounterInfoA(hCounter, bRetrieveExplainText, pdwBufferSize, lpBuffer)

#uselib "pdh.dll"
#func global PdhGetCounterInfoA "PdhGetCounterInfoA" sptr, sptr, sptr, sptr
; PdhGetCounterInfoA hCounter, bRetrieveExplainText, varptr(pdwBufferSize), varptr(lpBuffer)   ; 戻り値は stat
; hCounter : PDH_HCOUNTER -> "sptr"
; bRetrieveExplainText : BOOLEAN -> "sptr"
; pdwBufferSize : DWORD* in/out -> "sptr"
; lpBuffer : PDH_COUNTER_INFO_A* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "pdh.dll"
#cfunc global PdhGetCounterInfoA "PdhGetCounterInfoA" sptr, int, var, var
; res = PdhGetCounterInfoA(hCounter, bRetrieveExplainText, pdwBufferSize, lpBuffer)
; hCounter : PDH_HCOUNTER -> "sptr"
; bRetrieveExplainText : BOOLEAN -> "int"
; pdwBufferSize : DWORD* in/out -> "var"
; lpBuffer : PDH_COUNTER_INFO_A* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "pdh.dll"
#cfunc global PdhGetCounterInfoA "PdhGetCounterInfoA" sptr, int, sptr, sptr
; res = PdhGetCounterInfoA(hCounter, bRetrieveExplainText, varptr(pdwBufferSize), varptr(lpBuffer))
; hCounter : PDH_HCOUNTER -> "sptr"
; bRetrieveExplainText : BOOLEAN -> "int"
; pdwBufferSize : DWORD* in/out -> "sptr"
; lpBuffer : PDH_COUNTER_INFO_A* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。