ホーム › System.Performance › PdhGetRawCounterArrayA

PdhGetRawCounterArrayA

関数

ワイルドカードカウンターの生値配列を取得する(ANSI版)。

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

シグネチャ

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

DWORD PdhGetRawCounterArrayA(
    PDH_HCOUNTER hCounter,
    DWORD* lpdwBufferSize,
    DWORD* lpdwItemCount,
    PDH_RAW_COUNTER_ITEM_A* ItemBuffer   // optional
);

パラメーター

名前	型	方向	説明
hCounter	PDH_HCOUNTER	in	現在の生のインスタンス値を取得したいカウンターのハンドル。 PdhAddCounter 関数がこのハンドルを返します。
lpdwBufferSize	DWORD*	inout	ItemBuffer バッファのサイズ(バイト単位)。入力時に 0 の場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファサイズを設定します。バッファが必要なサイズより大きい場合、関数はこのパラメーターに実際に使用されたバッファのサイズを設定します。入力時に指定したサイズが 0 より大きく、かつ必要なサイズより小さい場合、返されたサイズを利用してバッファを再割り当てしないでください。
lpdwItemCount	DWORD*	out	ItemBuffer バッファ内の生のカウンター値の数。
ItemBuffer	PDH_RAW_COUNTER_ITEM_A*	outoptional	PDH_RAW_COUNTER_ITEM 構造体の配列を受け取る、呼び出し元が割り当てたバッファ。これらの構造体には生のインスタンスカウンター値が含まれます。lpdwBufferSize が 0 の場合は NULL を設定します。

戻り値の型: DWORD

公式ドキュメント

指定したカウンターから生の値の配列を返します。インスタンス名にワイルドカード文字を含むカウンターの生のカウンター値を取得したい場合に、この関数を使用します。(ANSI)

戻り値

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

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

戻り値	説明
PDH_MORE_DATA	ItemBuffer バッファがオブジェクト名を格納するのに十分な大きさではありません。入力時に lpdwBufferSize が 0 の場合、この戻り値が想定されます。入力時に指定したサイズが 0 より大きく、かつ必要なサイズより小さい場合、返されたサイズを利用してバッファを再割り当てしないでください。
PDH_INVALID_ARGUMENT	パラメーターが無効であるか、形式が正しくありません。たとえば、一部のリリースでは、入力時に指定したサイズが 0 より大きく、かつ必要なサイズより小さい場合に、このエラーを受け取ることがあります。
PDH_INVALID_HANDLE	カウンターハンドルが無効です。

解説(Remarks)

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

カウンターのデータは、呼び出し処理中の変更を防ぐため、 PdhGetRawCounterArray の呼び出しが続く間ロックされます。

メモ

pdh.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PdhGetRawCounterArray を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhGetRawCounterArrayA(
    PDH_HCOUNTER hCounter,
    DWORD* lpdwBufferSize,
    DWORD* lpdwItemCount,
    PDH_RAW_COUNTER_ITEM_A* ItemBuffer   // optional
);

[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhGetRawCounterArrayA(
    IntPtr hCounter,   // PDH_HCOUNTER
    ref uint lpdwBufferSize,   // DWORD* in/out
    out uint lpdwItemCount,   // DWORD* out
    IntPtr ItemBuffer   // PDH_RAW_COUNTER_ITEM_A* optional, out
);

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhGetRawCounterArrayA(
    hCounter As IntPtr,   ' PDH_HCOUNTER
    ByRef lpdwBufferSize As UInteger,   ' DWORD* in/out
    <Out> ByRef lpdwItemCount As UInteger,   ' DWORD* out
    ItemBuffer As IntPtr   ' PDH_RAW_COUNTER_ITEM_A* optional, out
) As UInteger
End Function

' hCounter : PDH_HCOUNTER
' lpdwBufferSize : DWORD* in/out
' lpdwItemCount : DWORD* out
' ItemBuffer : PDH_RAW_COUNTER_ITEM_A* optional, out
Declare PtrSafe Function PdhGetRawCounterArrayA Lib "pdh" ( _
    ByVal hCounter As LongPtr, _
    ByRef lpdwBufferSize As Long, _
    ByRef lpdwItemCount As Long, _
    ByVal ItemBuffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhGetRawCounterArrayA = ctypes.windll.pdh.PdhGetRawCounterArrayA
PdhGetRawCounterArrayA.restype = wintypes.DWORD
PdhGetRawCounterArrayA.argtypes = [
    wintypes.HANDLE,  # hCounter : PDH_HCOUNTER
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferSize : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # lpdwItemCount : DWORD* out
    ctypes.c_void_p,  # ItemBuffer : PDH_RAW_COUNTER_ITEM_A* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhGetRawCounterArrayA = Fiddle::Function.new(
  lib['PdhGetRawCounterArrayA'],
  [
    Fiddle::TYPE_VOIDP,  # hCounter : PDH_HCOUNTER
    Fiddle::TYPE_VOIDP,  # lpdwBufferSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpdwItemCount : DWORD* out
    Fiddle::TYPE_VOIDP,  # ItemBuffer : PDH_RAW_COUNTER_ITEM_A* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhGetRawCounterArrayA(
        hCounter: *mut core::ffi::c_void,  // PDH_HCOUNTER
        lpdwBufferSize: *mut u32,  // DWORD* in/out
        lpdwItemCount: *mut u32,  // DWORD* out
        ItemBuffer: *mut PDH_RAW_COUNTER_ITEM_A  // PDH_RAW_COUNTER_ITEM_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 PdhGetRawCounterArrayA(IntPtr hCounter, ref uint lpdwBufferSize, out uint lpdwItemCount, IntPtr ItemBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhGetRawCounterArrayA' -Namespace Win32 -PassThru
# $api::PdhGetRawCounterArrayA(hCounter, lpdwBufferSize, lpdwItemCount, ItemBuffer)

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

出力引数:

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