ホーム › System.Diagnostics.Etw › SetTraceCallback

SetTraceCallback

関数

指定したGUIDのイベントに対するコールバック関数を設定する。

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

シグネチャ

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

WIN32_ERROR SetTraceCallback(
    const GUID* pGuid,
    PEVENT_CALLBACK EventCallback
);

パラメーター

名前	型	方向	説明
pGuid	GUID*	in	イベントを受信する対象のイベントトレースクラスのクラス GUID へのポインター。カーネルプロバイダーのクラス GUID の一覧については、 NT Kernel Logger Constantsを参照してください。
EventCallback	PEVENT_CALLBACK	in	イベントトレースクラスに属するイベントを処理するために使用される EventCallback 関数へのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

SetTraceCallback 関数は、イベントを処理するための EventCallback 関数を指定します

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値はシステムエラーコードのいずれかです。以下に代表的なエラーとその原因を示します。

ERROR_INVALID_PARAMETER

次のいずれかに該当します。
- pGuid が NULL です。
- EventCallback が NULL です。

解説(Remarks)

この関数はコンシューマーが呼び出します。

イベントトレースクラスに対して指定できるコールバック関数は 1 つだけです。1 つのイベントトレースクラスに対して複数のコールバック関数を指定した場合、最後に指定したコールバック関数がそのイベントトレースクラスのイベントを受信します。

コールバック関数がイベントトレースクラスのイベントを受信しないようにするには、 RemoveTraceCallback関数を呼び出します。トレースを閉じると、コールバックは自動的にコールバックの受信を停止します。

この関数を使用すると、いずれかの TraceEvent関数で書き込まれたイベントを受信できます。イベントをログに記録するために EventWrite関数のいずれかを使用したプロバイダーからのイベントの消費には、この関数を使用できません。

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

各言語での呼び出し定義

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

WIN32_ERROR SetTraceCallback(
    const GUID* pGuid,
    PEVENT_CALLBACK EventCallback
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint SetTraceCallback(
    ref Guid pGuid,   // GUID*
    IntPtr EventCallback   // PEVENT_CALLBACK
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function SetTraceCallback(
    ByRef pGuid As Guid,   ' GUID*
    EventCallback As IntPtr   ' PEVENT_CALLBACK
) As UInteger
End Function

' pGuid : GUID*
' EventCallback : PEVENT_CALLBACK
Declare PtrSafe Function SetTraceCallback Lib "advapi32" ( _
    ByVal pGuid As LongPtr, _
    ByVal EventCallback As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetTraceCallback = ctypes.windll.advapi32.SetTraceCallback
SetTraceCallback.restype = wintypes.DWORD
SetTraceCallback.argtypes = [
    ctypes.c_void_p,  # pGuid : GUID*
    ctypes.c_void_p,  # EventCallback : PEVENT_CALLBACK
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
SetTraceCallback = Fiddle::Function.new(
  lib['SetTraceCallback'],
  [
    Fiddle::TYPE_VOIDP,  # pGuid : GUID*
    Fiddle::TYPE_VOIDP,  # EventCallback : PEVENT_CALLBACK
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn SetTraceCallback(
        pGuid: *const GUID,  // GUID*
        EventCallback: *const core::ffi::c_void  // PEVENT_CALLBACK
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint SetTraceCallback(ref Guid pGuid, IntPtr EventCallback);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_SetTraceCallback' -Namespace Win32 -PassThru
# $api::SetTraceCallback(pGuid, EventCallback)

#uselib "ADVAPI32.dll"
#func global SetTraceCallback "SetTraceCallback" sptr, sptr
; SetTraceCallback varptr(pGuid), EventCallback   ; 戻り値は stat
; pGuid : GUID* -> "sptr"
; EventCallback : PEVENT_CALLBACK -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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