ホーム › System.Performance › PerfSetCounterRefValue

PerfSetCounterRefValue

関数

カウンター値の参照先メモリアドレスを設定する。

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

シグネチャ

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

DWORD PerfSetCounterRefValue(
    HANDLE Provider,
    PERF_COUNTERSET_INSTANCE* Instance,
    DWORD CounterId,
    void* Address
);

パラメーター

名前	型	方向	説明
Provider	HANDLE	in	プロバイダーのハンドル。CTRPP ツールが生成したハンドル変数を使用します。変数名については、provider 要素の symbol 属性を参照してください。 Windows Vista: PerfStartProvider 関数がハンドルを返します。
Instance	PERF_COUNTERSET_INSTANCE*	inout	カウンターセットインスタンスを格納する PERF_COUNTERSET_INSTANCE 構造体。PerfCreateInstance 関数がこのポインターを返します。
CounterId	DWORD	in	インスタンスブロック内で更新するカウンターを一意に識別する識別子。この識別子は counter 要素の id 属性で定義され、インスタンスブロック内のいずれかの PERF_COUNTER_INFO 構造体の CounterId メンバーと一致する必要があります。CTRPP ツールが生成したカウンター ID 定数を使用します。定数名については、counter 要素の symbol 属性を参照してください。 Windows Vista: カウンター ID 定数は使用できません。
Address	void*	in	実際のカウンターデータへのポインター。 NULL の場合、コンシューマーは ERROR_NO_DATA を受け取ります。カウンターデータが参照によってアクセスされることを示すには、マニフェスト内のカウンター宣言に、name 属性が "reference" に設定された counterAttribute 要素を含める必要があります。

戻り値の型: DWORD

公式ドキュメント

値が実際のデータへのポインターであるカウンターの値を更新します。プロバイダーがこの関数を使用します。

戻り値

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

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

解説(Remarks)

これは、生のカウンターデータへの参照を指定するための便利な関数です。生のカウンターデータへの参照を自分で更新するには、PERF_COUNTER_INFO 構造体の Offset メンバーを使用して、特定のカウンターのカウンター値にアクセスします。Attrib メンバーには PERF_ATTRIB_BY_REFERENCE フラグを含める必要があります。PERF_COUNTERSET_INSTANCE 構造体ブロックには、1 つ以上のカウンター情報構造体が含まれます。

カウンターの種類に応じて、ポインターは 4 バイトまたは 8 バイトの符号なし整数を参照する必要があります。カウンターデータを収集する際、PERFLIB はポインターを逆参照して実際のデータを返します。

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

各言語での呼び出し定義

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

DWORD PerfSetCounterRefValue(
    HANDLE Provider,
    PERF_COUNTERSET_INSTANCE* Instance,
    DWORD CounterId,
    void* Address
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint PerfSetCounterRefValue(
    IntPtr Provider,   // HANDLE
    IntPtr Instance,   // PERF_COUNTERSET_INSTANCE* in/out
    uint CounterId,   // DWORD
    IntPtr Address   // void*
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function PerfSetCounterRefValue(
    Provider As IntPtr,   ' HANDLE
    Instance As IntPtr,   ' PERF_COUNTERSET_INSTANCE* in/out
    CounterId As UInteger,   ' DWORD
    Address As IntPtr   ' void*
) As UInteger
End Function

' Provider : HANDLE
' Instance : PERF_COUNTERSET_INSTANCE* in/out
' CounterId : DWORD
' Address : void*
Declare PtrSafe Function PerfSetCounterRefValue Lib "advapi32" ( _
    ByVal Provider As LongPtr, _
    ByVal Instance As LongPtr, _
    ByVal CounterId As Long, _
    ByVal Address As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PerfSetCounterRefValue = ctypes.windll.advapi32.PerfSetCounterRefValue
PerfSetCounterRefValue.restype = wintypes.DWORD
PerfSetCounterRefValue.argtypes = [
    wintypes.HANDLE,  # Provider : HANDLE
    ctypes.c_void_p,  # Instance : PERF_COUNTERSET_INSTANCE* in/out
    wintypes.DWORD,  # CounterId : DWORD
    ctypes.POINTER(None),  # Address : void*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
PerfSetCounterRefValue = Fiddle::Function.new(
  lib['PerfSetCounterRefValue'],
  [
    Fiddle::TYPE_VOIDP,  # Provider : HANDLE
    Fiddle::TYPE_VOIDP,  # Instance : PERF_COUNTERSET_INSTANCE* in/out
    -Fiddle::TYPE_INT,  # CounterId : DWORD
    Fiddle::TYPE_VOIDP,  # Address : void*
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn PerfSetCounterRefValue(
        Provider: *mut core::ffi::c_void,  // HANDLE
        Instance: *mut PERF_COUNTERSET_INSTANCE,  // PERF_COUNTERSET_INSTANCE* in/out
        CounterId: u32,  // DWORD
        Address: *mut ()  // void*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint PerfSetCounterRefValue(IntPtr Provider, IntPtr Instance, uint CounterId, IntPtr Address);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_PerfSetCounterRefValue' -Namespace Win32 -PassThru
# $api::PerfSetCounterRefValue(Provider, Instance, CounterId, Address)

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

出力引数:

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