ホーム › System.Performance › PerfAddCounters

PerfAddCounters

関数

照会ハンドルに収集対象カウンターを追加する。

DLLADVAPI32.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

DWORD PerfAddCounters(
    HANDLE hQuery,
    PERF_COUNTER_IDENTIFIER* pCounters,
    DWORD cbCounters
);

パラメーター

名前	型	方向	説明
hQuery	HANDLE	in	パフォーマンスカウンターの指定を追加する対象のクエリへのハンドルです。
pCounters	PERF_COUNTER_IDENTIFIER*	inout	追加するパフォーマンスカウンターの指定へのポインターです。
cbCounters	DWORD	in	pCounters パラメーターが指定するバッファーのサイズ(バイト単位)です。

戻り値の型: DWORD

公式ドキュメント

指定したクエリにパフォーマンスカウンターの指定を追加します。

戻り値

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

関数が失敗した場合の戻り値は、システムエラーコードです。

解説(Remarks)

pCounters パラメーターは、一連の PERF_COUNTER_IDENTIFIER ブロックを指す必要があります。各 PERF_COUNTER_IDENTIFIER ブロックは、 PERF_COUNTER_IDENTIFIER 構造体と、それに続く省略可能な null 終端の UTF-16LE インスタンス名文字列、さらにブロックのサイズが 8 バイトの倍数になるようにするパディングで構成されます。

各 PERF_COUNTER_IDENTIFIER ブロックについて、次のように設定します。

PERF_COUNTER_IDENTIFIER 構造体の CounterSetGuid メンバーに、クエリ対象のカウンターセットの識別子を設定します。
PERF_COUNTER_IDENTIFIER 構造体の Status メンバーに 0 を設定します。
PERF_COUNTER_IDENTIFIER 構造体の Size メンバーに、 PERF_COUNTER_IDENTIFIER 構造体、インスタンス名、およびパディングを含む PERF_COUNTER_IDENTIFIER ブロックのサイズ(バイト単位)を設定します。 Size の値は 8 の倍数でなければなりません。
PERF_COUNTER_IDENTIFIER 構造体の CounterId メンバーに、クエリで返されるべきカウンターの識別子を設定します。すべてのカウンターを返すには、CounterId に PERF_WILDCARD_COUNTER を設定します。
PERF_COUNTER_IDENTIFIER 構造体の InstanceId メンバーに、クエリで返されるべきインスタンスの識別子を設定します。インスタンス識別子に基づくフィルタリングを行わない場合は、 InstanceId に PERF_WILDCARD_COUNTER を設定します。
PERF_COUNTER_IDENTIFIER 構造体の Index メンバーに 0 を設定します。
PERF_COUNTER_IDENTIFIER 構造体の Reserved メンバーに 0 を設定します。
インスタンス名を PERF_COUNTER_IDENTIFIER 構造体の直後に含めます。
- カウンターセットが単一インスタンスの場合は、インスタンス名を設定しないでください。この場合、PERF_COUNTER_IDENTIFIER 構造体の Size メンバーの値は PERF_COUNTER_IDENTIFIER 構造体のサイズでなければなりません。
- カウンターセットが複数インスタンスの場合は、インスタンス名を設定する必要があります。インスタンス名に基づいてパフォーマンスカウンターの指定をフィルタリングしたくない場合は、インスタンス名として PERF_WILDCARD_INSTANCE を使用します。

PerfAddCounters は、各 PERF_COUNTER_IDENTIFIER ブロックごとに 1 つのカウンター指定をクエリに追加しようとし、各ブロック内の PERF_COUNTER_IDENTIFIER 構造体の Status メンバーをその試行の結果で更新します。

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

DWORD PerfAddCounters(
    HANDLE hQuery,
    PERF_COUNTER_IDENTIFIER* pCounters,
    DWORD cbCounters
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint PerfAddCounters(
    IntPtr hQuery,   // HANDLE
    IntPtr pCounters,   // PERF_COUNTER_IDENTIFIER* in/out
    uint cbCounters   // DWORD
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function PerfAddCounters(
    hQuery As IntPtr,   ' HANDLE
    pCounters As IntPtr,   ' PERF_COUNTER_IDENTIFIER* in/out
    cbCounters As UInteger   ' DWORD
) As UInteger
End Function

' hQuery : HANDLE
' pCounters : PERF_COUNTER_IDENTIFIER* in/out
' cbCounters : DWORD
Declare PtrSafe Function PerfAddCounters Lib "advapi32" ( _
    ByVal hQuery As LongPtr, _
    ByVal pCounters As LongPtr, _
    ByVal cbCounters As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PerfAddCounters = ctypes.windll.advapi32.PerfAddCounters
PerfAddCounters.restype = wintypes.DWORD
PerfAddCounters.argtypes = [
    wintypes.HANDLE,  # hQuery : HANDLE
    ctypes.c_void_p,  # pCounters : PERF_COUNTER_IDENTIFIER* in/out
    wintypes.DWORD,  # cbCounters : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
PerfAddCounters = Fiddle::Function.new(
  lib['PerfAddCounters'],
  [
    Fiddle::TYPE_VOIDP,  # hQuery : HANDLE
    Fiddle::TYPE_VOIDP,  # pCounters : PERF_COUNTER_IDENTIFIER* in/out
    -Fiddle::TYPE_INT,  # cbCounters : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn PerfAddCounters(
        hQuery: *mut core::ffi::c_void,  // HANDLE
        pCounters: *mut PERF_COUNTER_IDENTIFIER,  // PERF_COUNTER_IDENTIFIER* in/out
        cbCounters: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint PerfAddCounters(IntPtr hQuery, IntPtr pCounters, uint cbCounters);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_PerfAddCounters' -Namespace Win32 -PassThru
# $api::PerfAddCounters(hQuery, pCounters, cbCounters)

#uselib "ADVAPI32.dll"
#func global PerfAddCounters "PerfAddCounters" sptr, sptr, sptr
; PerfAddCounters hQuery, varptr(pCounters), cbCounters   ; 戻り値は stat
; hQuery : HANDLE -> "sptr"
; pCounters : PERF_COUNTER_IDENTIFIER* in/out -> "sptr"
; cbCounters : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global PerfAddCounters "PerfAddCounters" sptr, var, int
; res = PerfAddCounters(hQuery, pCounters, cbCounters)
; hQuery : HANDLE -> "sptr"
; pCounters : PERF_COUNTER_IDENTIFIER* in/out -> "var"
; cbCounters : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global PerfAddCounters "PerfAddCounters" sptr, sptr, int
; res = PerfAddCounters(hQuery, varptr(pCounters), cbCounters)
; hQuery : HANDLE -> "sptr"
; pCounters : PERF_COUNTER_IDENTIFIER* in/out -> "sptr"
; cbCounters : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。