ホーム › System.Performance › PdhGetRawCounterArrayW

PdhGetRawCounterArrayW

関数

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

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

シグネチャ

// pdh.dll  (Unicode / -W)
#include <windows.h>

DWORD PdhGetRawCounterArrayW(
    PDH_HCOUNTER hCounter,
    DWORD* lpdwBufferSize,
    DWORD* lpdwItemCount,
    PDH_RAW_COUNTER_ITEM_W* ItemBuffer   // optional
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

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

解説(Remarks)

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

カウンターのデータは、呼び出しの処理中に変更が発生しないよう、 PdhGetRawCounterArray の呼び出し中はロックされます。

メモ

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

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

各言語での呼び出し定義

// pdh.dll  (Unicode / -W)
#include <windows.h>

DWORD PdhGetRawCounterArrayW(
    PDH_HCOUNTER hCounter,
    DWORD* lpdwBufferSize,
    DWORD* lpdwItemCount,
    PDH_RAW_COUNTER_ITEM_W* ItemBuffer   // optional
);

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

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhGetRawCounterArrayW(
    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_W* optional, out
) As UInteger
End Function

' hCounter : PDH_HCOUNTER
' lpdwBufferSize : DWORD* in/out
' lpdwItemCount : DWORD* out
' ItemBuffer : PDH_RAW_COUNTER_ITEM_W* optional, out
Declare PtrSafe Function PdhGetRawCounterArrayW Lib "pdh" ( _
    ByVal hCounter As LongPtr, _
    ByRef lpdwBufferSize As Long, _
    ByRef lpdwItemCount As Long, _
    ByVal ItemBuffer As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhGetRawCounterArrayW = ctypes.windll.pdh.PdhGetRawCounterArrayW
PdhGetRawCounterArrayW.restype = wintypes.DWORD
PdhGetRawCounterArrayW.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_W* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhGetRawCounterArrayW = Fiddle::Function.new(
  lib['PdhGetRawCounterArrayW'],
  [
    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_W* optional, out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "pdh")]
extern "system" {
    fn PdhGetRawCounterArrayW(
        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_W  // PDH_RAW_COUNTER_ITEM_W* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Unicode)]
public static extern uint PdhGetRawCounterArrayW(IntPtr hCounter, ref uint lpdwBufferSize, out uint lpdwItemCount, IntPtr ItemBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhGetRawCounterArrayW' -Namespace Win32 -PassThru
# $api::PdhGetRawCounterArrayW(hCounter, lpdwBufferSize, lpdwItemCount, ItemBuffer)

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

出力引数:

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