ホーム › System.Performance › PdhGetFormattedCounterArrayA

PdhGetFormattedCounterArrayA

関数

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

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

シグネチャ

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

DWORD PdhGetFormattedCounterArrayA(
    PDH_HCOUNTER hCounter,
    PDH_FMT dwFormat,
    DWORD* lpdwBufferSize,
    DWORD* lpdwItemCount,
    PDH_FMT_COUNTERVALUE_ITEM_A* ItemBuffer   // optional
);

パラメーター

名前

型

方向

説明

hCounter

PDH_HCOUNTER

現在値をフォーマットしたいカウンターのハンドル。このハンドルは PdhAddCounter 関数が返します。

dwFormat

PDH_FMT

フォーマット済み値のデータ型を決定します。次のいずれかの値を指定します。

値	意味
PDH_FMT_DOUBLE	データを倍精度浮動小数点実数として返します。
PDH_FMT_LARGE	データを 64 ビット整数として返します。
PDH_FMT_LONG	データを long 整数として返します。

ビットごとの論理和演算子 (|) を使用して、データ型を次のいずれかのスケーリング係数と組み合わせることができます。

値	意味
PDH_FMT_NOSCALE	カウンターの既定のスケーリング係数を適用しません。
PDH_FMT_NOCAP100	100 を超えるカウンター値 (たとえばマルチプロセッサコンピューターでプロセッサ負荷を測定するカウンター値など) を 100 にリセットしません。既定の動作では、カウンター値は 100 で上限が設定されます。
PDH_FMT_1000	実際の値に 1,000 を掛けます。

lpdwBufferSize

DWORD*

inout

ItemBuffer バッファーのサイズ (バイト単位)。入力時にゼロの場合、この関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、この関数は使用された実際のバッファーサイズをこのパラメーターに設定します。入力時に指定したサイズがゼロより大きく必要なサイズより小さい場合、返されたサイズを使ってバッファーを再割り当てしてはいけません。

lpdwItemCount

DWORD*

out

ItemBuffer バッファー内のカウンター値の数。

ItemBuffer

PDH_FMT_COUNTERVALUE_ITEM_A*

outoptional

PDH_FMT_COUNTERVALUE_ITEM 構造体の配列を受け取る、呼び出し側が割り当てたバッファー。これらの構造体にはカウンター値が格納されます。lpdwBufferSize がゼロの場合は NULL を設定します。

戻り値の型: DWORD

公式ドキュメント

フォーマット済みのカウンター値の配列を返します。インスタンス名にワイルドカード文字を含むカウンターの値をフォーマットしたい場合に、この関数を使用します。(ANSI)

戻り値

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

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

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

解説(Remarks)

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

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

例

次の例は、この関数の使用方法を示しています。


#include <windows.h>
#include <stdio.h>
#include <pdh.h>
#include <pdhmsg.h>

#pragma comment(lib, "pdh.lib")

CONST PWSTR COUNTER_PATH = L"\\Processor(*)\\% Processor Time";
CONST ULONG SAMPLE_INTERVAL_MS = 1000;

void main()
{
    PDH_HQUERY hQuery = NULL;
    PDH_STATUS status = ERROR_SUCCESS;
    PDH_HCOUNTER hCounter = NULL;   
    DWORD dwBufferSize = 0;         // Size of the pItems buffer
    DWORD dwItemCount = 0;          // Number of items in the pItems buffer
    PDH_FMT_COUNTERVALUE_ITEM *pItems = NULL;  // Array of PDH_FMT_COUNTERVALUE_ITEM structures

    if (status = PdhOpenQuery(NULL, 0, &hQuery))
    {
        wprintf(L"PdhOpenQuery failed with 0x%x.\n", status);
        goto cleanup;
    }

    // Specify a counter object with a wildcard for the instance.
    if (status = PdhAddCounter(hQuery, COUNTER_PATH, 0, &hCounter))
    {
        wprintf(L"PdhAddCounter failed with 0x%x.\n", status);
        goto cleanup;
    }

    // Some counters need two sample in order to format a value, so
    // make this call to get the first value before entering the loop.
    if (status = PdhCollectQueryData(hQuery))
    {
        wprintf(L"PdhCollectQueryData failed with 0x%x.\n", status);
        goto cleanup;
    }

    for (int i = 0; i < 10; i++)
    {
        Sleep(SAMPLE_INTERVAL_MS);

        if (status = PdhCollectQueryData(hQuery))
        {
            wprintf(L"PdhCollectQueryData failed with 0x%x.\n", status);
            goto cleanup;
        }

        // Get the required size of the pItems buffer.
        status = PdhGetFormattedCounterArray(hCounter, PDH_FMT_DOUBLE, &dwBufferSize, &dwItemCount, pItems);
        if (PDH_MORE_DATA == status)
        {
            pItems = (PDH_FMT_COUNTERVALUE_ITEM *) malloc(dwBufferSize);
            if (pItems)
            {
                status = PdhGetFormattedCounterArray(hCounter, PDH_FMT_DOUBLE, &dwBufferSize, &dwItemCount, pItems);
                if (ERROR_SUCCESS == status)
                {
                    // Loop through the array and print the instance name and counter value.
                    for (DWORD i = 0; i < dwItemCount; i++)
                    {
                        wprintf(L"counter: %s, value %.20g\n", pItems[i].szName, pItems[i].FmtValue.doubleValue);
                    }
                }
                else
                {
                    wprintf(L"Second PdhGetFormattedCounterArray call failed with 0x%x.\n", status);
                    goto cleanup;
                }

                free(pItems);
                pItems = NULL;
                dwBufferSize = dwItemCount = 0;
            }
            else
            {
                wprintf(L"malloc for PdhGetFormattedCounterArray failed.\n");
                goto cleanup;
            }
        }
        else
        {
            wprintf(L"PdhGetFormattedCounterArray failed with 0x%x.\n", status);
            goto cleanup;
        }
    }

cleanup:

    if (pItems)
        free(pItems);

    if (hQuery)
        PdhCloseQuery(hQuery); // Closes all counter handles and the query handle
}

メモ

pdh.h ヘッダーは PdhGetFormattedCounterArray を、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 PdhGetFormattedCounterArrayA(
    PDH_HCOUNTER hCounter,
    PDH_FMT dwFormat,
    DWORD* lpdwBufferSize,
    DWORD* lpdwItemCount,
    PDH_FMT_COUNTERVALUE_ITEM_A* ItemBuffer   // optional
);

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

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

' hCounter : PDH_HCOUNTER
' dwFormat : PDH_FMT
' lpdwBufferSize : DWORD* in/out
' lpdwItemCount : DWORD* out
' ItemBuffer : PDH_FMT_COUNTERVALUE_ITEM_A* optional, out
Declare PtrSafe Function PdhGetFormattedCounterArrayA Lib "pdh" ( _
    ByVal hCounter As LongPtr, _
    ByVal dwFormat As Long, _
    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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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