ホーム › System.Performance › PerfDecrementULongLongCounterValue

PerfDecrementULongLongCounterValue

関数

ULongLong型カウンターの値を指定量だけ減少させる。

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

シグネチャ

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

DWORD PerfDecrementULongLongCounterValue(
    HANDLE Provider,
    PERF_COUNTERSET_INSTANCE* Instance,
    DWORD CounterId,
    ULONGLONG 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	ULONGLONG	in	カウンターを減算する値。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

カウンター値を最初に設定するには、PerfSetULongLongCounterValue 関数を使用してください。

カウンター値がゼロを下回って減算されると、アンダーフローが発生する点に注意してください。

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

各言語での呼び出し定義

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

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

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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