ホーム › System.Performance › PerfStartProviderEx

PerfStartProviderEx

関数

コンテキストを指定してパフォーマンスカウンタプロバイダを開始する。

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

シグネチャ

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

DWORD PerfStartProviderEx(
    GUID* ProviderGuid,
    PERF_PROVIDER_CONTEXT* ProviderContext,   // optional
    HANDLE* Provider
);

パラメーター

名前	型	方向	説明
ProviderGuid	GUID*	in	プロバイダーを一意に識別する GUID。provider 要素の providerGuid 属性でこの GUID を指定します。
ProviderContext	PERF_PROVIDER_CONTEXT*	inoptional	制御コールバック、メモリ管理ルーチン、およびコンテキスト情報へのポインターを格納した PERF_PROVIDER_CONTEXT 構造体。
Provider	HANDLE*	out	プロバイダーへのハンドル。このハンドルに関連付けられたリソースを解放するには、PerfStopProvider を呼び出す必要があります。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

この関数は CounterInitialize 関数によって呼び出されます。この関数を直接呼び出さないでください。

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

CTRPP ツールは、CTRPP の呼び出し時に -MemoryRoutines 引数または -NotificationCallback 引数を使用した場合、あるいは provider 要素の callback 属性が "custom" に設定されている場合に、PerfStartProvider の代わりにこの関数を含めます。

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

各言語での呼び出し定義

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

DWORD PerfStartProviderEx(
    GUID* ProviderGuid,
    PERF_PROVIDER_CONTEXT* ProviderContext,   // optional
    HANDLE* Provider
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint PerfStartProviderEx(
    ref Guid ProviderGuid,   // GUID*
    IntPtr ProviderContext,   // PERF_PROVIDER_CONTEXT* optional
    IntPtr Provider   // HANDLE* out
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function PerfStartProviderEx(
    ByRef ProviderGuid As Guid,   ' GUID*
    ProviderContext As IntPtr,   ' PERF_PROVIDER_CONTEXT* optional
    Provider As IntPtr   ' HANDLE* out
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

PerfStartProviderEx = ctypes.windll.advapi32.PerfStartProviderEx
PerfStartProviderEx.restype = wintypes.DWORD
PerfStartProviderEx.argtypes = [
    ctypes.c_void_p,  # ProviderGuid : GUID*
    ctypes.c_void_p,  # ProviderContext : PERF_PROVIDER_CONTEXT* optional
    ctypes.c_void_p,  # Provider : HANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
PerfStartProviderEx = Fiddle::Function.new(
  lib['PerfStartProviderEx'],
  [
    Fiddle::TYPE_VOIDP,  # ProviderGuid : GUID*
    Fiddle::TYPE_VOIDP,  # ProviderContext : PERF_PROVIDER_CONTEXT* optional
    Fiddle::TYPE_VOIDP,  # Provider : HANDLE* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn PerfStartProviderEx(
        ProviderGuid: *mut GUID,  // GUID*
        ProviderContext: *mut PERF_PROVIDER_CONTEXT,  // PERF_PROVIDER_CONTEXT* optional
        Provider: *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 PerfStartProviderEx(ref Guid ProviderGuid, IntPtr ProviderContext, IntPtr Provider);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_PerfStartProviderEx' -Namespace Win32 -PassThru
# $api::PerfStartProviderEx(ProviderGuid, ProviderContext, Provider)

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

出力引数:

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