ホーム › System.Performance › PerfIncrementULongCounterValue

PerfIncrementULongCounterValue

関数

ULong型カウンターの値を指定量だけ増加させる。

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

シグネチャ

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

DWORD PerfIncrementULongCounterValue(
    HANDLE Provider,
    PERF_COUNTERSET_INSTANCE* Instance,
    DWORD CounterId,
    DWORD Value
);

パラメーター

名前	型	方向	説明
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 定数は使用できません。
Value	DWORD	in	カウンターをインクリメントする値。

戻り値の型: DWORD

公式ドキュメント

値が 4 バイトの符号なし整数であるカウンターの値をインクリメントします。プロバイダーがこの関数を使用します。

戻り値

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

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

解説(Remarks)

これは、生のカウンターデータをインクリメントするための便利な関数です。生のカウンターデータを自分でインクリメントするには、PERF_COUNTER_INFO 構造体の Offset メンバーを使用して、特定のカウンターの生のカウンターデータにアクセスします。PERF_COUNTERSET_INSTANCE 構造体ブロックには、1 つ以上のカウンター情報構造体が含まれます。

カウンター値を最初に設定するには、PerfSetULongCounterValue 関数を使用します。

カウンター値が 4 バイトの符号なし整数の最大サイズを超えてインクリメントされると、オーバーフローすることに注意してください。

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

各言語での呼び出し定義

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

DWORD PerfIncrementULongCounterValue(
    HANDLE Provider,
    PERF_COUNTERSET_INSTANCE* Instance,
    DWORD CounterId,
    DWORD Value
);

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

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

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

import ctypes
from ctypes import wintypes

PerfIncrementULongCounterValue = ctypes.windll.advapi32.PerfIncrementULongCounterValue
PerfIncrementULongCounterValue.restype = wintypes.DWORD
PerfIncrementULongCounterValue.argtypes = [
    wintypes.HANDLE,  # Provider : HANDLE
    ctypes.c_void_p,  # Instance : PERF_COUNTERSET_INSTANCE* in/out
    wintypes.DWORD,  # CounterId : DWORD
    wintypes.DWORD,  # Value : DWORD
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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