ホーム › System.Performance › PerfStartProvider

PerfStartProvider

関数

パフォーマンスカウンタプロバイダを開始する。

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

シグネチャ

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

DWORD PerfStartProvider(
    GUID* ProviderGuid,
    PERFLIBREQUEST ControlCallback,   // optional
    HANDLE* phProvider
);

パラメーター

名前	型	方向	説明
ProviderGuid	GUID*	in	プロバイダーを一意に識別する GUID。provider 要素の providerGuid 属性でこの GUID を指定します。
ControlCallback	PERFLIBREQUEST	inoptional	クエリへのカウンターの追加や削除といったコンシューマーからの要求を通知するために PERFLIB が呼び出す ControlCallback 関数。このパラメーターは、counters 要素の callback 属性が "custom" の場合に設定します。それ以外の場合は NULL を指定します。
phProvider	HANDLE*	out	プロバイダーへのハンドル。このハンドルに関連付けられたリソースを解放するには、PerfStopProvider を呼び出す必要があります。

戻り値の型: DWORD

公式ドキュメント

プロバイダーを登録します。(PerfStartProvider)

戻り値

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

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

解説(Remarks)

CounterInitialize 関数がこの関数を呼び出します。この関数を直接呼び出さないでください。

Windows Vista: PerfAutoInitialize 関数がこの関数を呼び出します。

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

各言語での呼び出し定義

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

DWORD PerfStartProvider(
    GUID* ProviderGuid,
    PERFLIBREQUEST ControlCallback,   // optional
    HANDLE* phProvider
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint PerfStartProvider(
    ref Guid ProviderGuid,   // GUID*
    IntPtr ControlCallback,   // PERFLIBREQUEST optional
    IntPtr phProvider   // HANDLE* out
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function PerfStartProvider(
    ByRef ProviderGuid As Guid,   ' GUID*
    ControlCallback As IntPtr,   ' PERFLIBREQUEST optional
    phProvider As IntPtr   ' HANDLE* out
) As UInteger
End Function

' ProviderGuid : GUID*
' ControlCallback : PERFLIBREQUEST optional
' phProvider : HANDLE* out
Declare PtrSafe Function PerfStartProvider Lib "advapi32" ( _
    ByVal ProviderGuid As LongPtr, _
    ByVal ControlCallback As LongPtr, _
    ByVal phProvider As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PerfStartProvider = ctypes.windll.advapi32.PerfStartProvider
PerfStartProvider.restype = wintypes.DWORD
PerfStartProvider.argtypes = [
    ctypes.c_void_p,  # ProviderGuid : GUID*
    ctypes.c_void_p,  # ControlCallback : PERFLIBREQUEST optional
    ctypes.c_void_p,  # phProvider : HANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
PerfStartProvider = Fiddle::Function.new(
  lib['PerfStartProvider'],
  [
    Fiddle::TYPE_VOIDP,  # ProviderGuid : GUID*
    Fiddle::TYPE_VOIDP,  # ControlCallback : PERFLIBREQUEST optional
    Fiddle::TYPE_VOIDP,  # phProvider : HANDLE* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn PerfStartProvider(
        ProviderGuid: *mut GUID,  // GUID*
        ControlCallback: *const core::ffi::c_void,  // PERFLIBREQUEST optional
        phProvider: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint PerfStartProvider(ref Guid ProviderGuid, IntPtr ControlCallback, IntPtr phProvider);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_PerfStartProvider' -Namespace Win32 -PassThru
# $api::PerfStartProvider(ProviderGuid, ControlCallback, phProvider)

#uselib "ADVAPI32.dll"
#func global PerfStartProvider "PerfStartProvider" sptr, sptr, sptr
; PerfStartProvider varptr(ProviderGuid), ControlCallback, phProvider   ; 戻り値は stat
; ProviderGuid : GUID* -> "sptr"
; ControlCallback : PERFLIBREQUEST optional -> "sptr"
; phProvider : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global PerfStartProvider "PerfStartProvider" var, sptr, sptr
; res = PerfStartProvider(ProviderGuid, ControlCallback, phProvider)
; ProviderGuid : GUID* -> "var"
; ControlCallback : PERFLIBREQUEST optional -> "sptr"
; phProvider : HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global PerfStartProvider "PerfStartProvider" sptr, sptr, sptr
; res = PerfStartProvider(varptr(ProviderGuid), ControlCallback, phProvider)
; ProviderGuid : GUID* -> "sptr"
; ControlCallback : PERFLIBREQUEST optional -> "sptr"
; phProvider : HANDLE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。