Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Etw › EventProviderEnabled

EventProviderEnabled

関数
指定レベルとキーワードでプロバイダーが有効かを判定する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

BOOLEAN EventProviderEnabled(
    REGHANDLE RegHandle,
    BYTE Level,
    ULONGLONG Keyword
);

パラメーター

名前方向説明
RegHandleREGHANDLEin

プロバイダーの登録ハンドル。このハンドルは EventRegister から取得します。

RegHandleNULL の場合、EventProviderEnabledFALSE を返します。

LevelBYTEinイベントの重大度や重要度を表す 8 ビットの数値です。イベント レベル値の詳細については、 EVENT_DESCRIPTOR を参照してください。
KeywordULONGLONGinイベントが属するイベント カテゴリの集合を示す 64 ビットのビットマスクです。イベント キーワード値の詳細については、 EVENT_DESCRIPTOR を参照してください。

戻り値の型: BOOLEAN

公式ドキュメント

イベント プロバイダーが特定のイベントを生成すべきかどうかを判定します。

戻り値

指定されたプロバイダーからの特定のイベントを待ち受けているセッションが存在しないと ETW が即座に判断できる場合は FALSE を返します。それ以外の場合は TRUE を返します。

解説(Remarks)

この API は、プロバイダー ハンドル、イベント レベル、およびイベント キーワードに基づいて、イベントが有効かどうか (つまり、いずれかのイベント コンシューマー セッションがそのイベントの受信を必要としているかどうか) を簡単に判定する手段を提供します。

メモ

この API は控えめなクイック テストを実行します。後続の詳細なフィルター処理では、どのセッションもそのイベントを記録する必要がないと判断されるような場合でも、この API が true を返す可能性があります。

この API は、EventEnabled が提供する機能と同様の機能を提供します。プロバイダーがイベントの完全な EVENT_DESCRIPTOR にアクセスできる場合は、EventEnabled を使用してください。プロバイダーがイベントの Level と Keyword にのみアクセスできる場合は、EventProviderEnabled を使用してください。

ほとんどのイベント プロバイダーは、EventProviderEnabled を直接呼び出すことはありません。

詳細については、EventEnabled を参照してください。

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

各言語での呼び出し定義

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

BOOLEAN EventProviderEnabled(
    REGHANDLE RegHandle,
    BYTE Level,
    ULONGLONG Keyword
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern bool EventProviderEnabled(
    long RegHandle,   // REGHANDLE
    byte Level,   // BYTE
    ulong Keyword   // ULONGLONG
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function EventProviderEnabled(
    RegHandle As Long,   ' REGHANDLE
    Level As Byte,   ' BYTE
    Keyword As ULong   ' ULONGLONG
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' RegHandle : REGHANDLE
' Level : BYTE
' Keyword : ULONGLONG
Declare PtrSafe Function EventProviderEnabled Lib "advapi32" ( _
    ByVal RegHandle As LongLong, _
    ByVal Level As Byte, _
    ByVal Keyword As LongLong) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EventProviderEnabled = ctypes.windll.advapi32.EventProviderEnabled
EventProviderEnabled.restype = wintypes.BOOLEAN
EventProviderEnabled.argtypes = [
    ctypes.c_longlong,  # RegHandle : REGHANDLE
    ctypes.c_ubyte,  # Level : BYTE
    ctypes.c_ulonglong,  # Keyword : ULONGLONG
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
EventProviderEnabled = Fiddle::Function.new(
  lib['EventProviderEnabled'],
  [
    Fiddle::TYPE_LONG_LONG,  # RegHandle : REGHANDLE
    -Fiddle::TYPE_CHAR,  # Level : BYTE
    -Fiddle::TYPE_LONG_LONG,  # Keyword : ULONGLONG
  ],
  Fiddle::TYPE_CHAR)
#[link(name = "advapi32")]
extern "system" {
    fn EventProviderEnabled(
        RegHandle: i64,  // REGHANDLE
        Level: u8,  // BYTE
        Keyword: u64  // ULONGLONG
    ) -> u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("ADVAPI32.dll")]
public static extern bool EventProviderEnabled(long RegHandle, byte Level, ulong Keyword);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_EventProviderEnabled' -Namespace Win32 -PassThru
# $api::EventProviderEnabled(RegHandle, Level, Keyword)
#uselib "ADVAPI32.dll"
#func global EventProviderEnabled "EventProviderEnabled" sptr, sptr, sptr
; EventProviderEnabled RegHandle, Level, Keyword   ; 戻り値は stat
; RegHandle : REGHANDLE -> "sptr"
; Level : BYTE -> "sptr"
; Keyword : ULONGLONG -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global EventProviderEnabled "EventProviderEnabled" int64, int, int64
; res = EventProviderEnabled(RegHandle, Level, Keyword)
; RegHandle : REGHANDLE -> "int64"
; Level : BYTE -> "int"
; Keyword : ULONGLONG -> "int64"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; BOOLEAN EventProviderEnabled(REGHANDLE RegHandle, BYTE Level, ULONGLONG Keyword)
#uselib "ADVAPI32.dll"
#cfunc global EventProviderEnabled "EventProviderEnabled" int64, int, int64
; res = EventProviderEnabled(RegHandle, Level, Keyword)
; RegHandle : REGHANDLE -> "int64"
; Level : BYTE -> "int"
; Keyword : ULONGLONG -> "int64"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procEventProviderEnabled = advapi32.NewProc("EventProviderEnabled")
)

// RegHandle (REGHANDLE), Level (BYTE), Keyword (ULONGLONG)
r1, _, err := procEventProviderEnabled.Call(
	uintptr(RegHandle),
	uintptr(Level),
	uintptr(Keyword),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOLEAN
function EventProviderEnabled(
  RegHandle: Int64;   // REGHANDLE
  Level: Byte;   // BYTE
  Keyword: UInt64   // ULONGLONG
): ByteBool; stdcall;
  external 'ADVAPI32.dll' name 'EventProviderEnabled';
result := DllCall("ADVAPI32\EventProviderEnabled"
    , "Int64", RegHandle   ; REGHANDLE
    , "UChar", Level   ; BYTE
    , "Int64", Keyword   ; ULONGLONG
    , "Char")   ; return: BOOLEAN
●EventProviderEnabled(RegHandle, Level, Keyword) = DLL("ADVAPI32.dll", "byte EventProviderEnabled(int64, byte, qword)")
# 呼び出し: EventProviderEnabled(RegHandle, Level, Keyword)
# RegHandle : REGHANDLE -> "int64"
# Level : BYTE -> "byte"
# Keyword : ULONGLONG -> "qword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn EventProviderEnabled(
    RegHandle: i64, // REGHANDLE
    Level: u8, // BYTE
    Keyword: u64 // ULONGLONG
) callconv(std.os.windows.WINAPI) u8;
proc EventProviderEnabled(
    RegHandle: int64,  # REGHANDLE
    Level: uint8,  # BYTE
    Keyword: uint64  # ULONGLONG
): uint8 {.importc: "EventProviderEnabled", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
ubyte EventProviderEnabled(
    long RegHandle,   // REGHANDLE
    ubyte Level,   // BYTE
    ulong Keyword   // ULONGLONG
);
ccall((:EventProviderEnabled, "ADVAPI32.dll"), stdcall, UInt8,
      (Int64, UInt8, UInt64),
      RegHandle, Level, Keyword)
# RegHandle : REGHANDLE -> Int64
# Level : BYTE -> UInt8
# Keyword : ULONGLONG -> UInt64
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint8_t EventProviderEnabled(
    int64_t RegHandle,
    uint8_t Level,
    uint64_t Keyword);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.EventProviderEnabled(RegHandle, Level, Keyword)
-- RegHandle : REGHANDLE
-- Level : BYTE
-- Keyword : ULONGLONG
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const EventProviderEnabled = lib.func('__stdcall', 'EventProviderEnabled', 'uint8_t', ['int64_t', 'uint8_t', 'uint64_t']);
// EventProviderEnabled(RegHandle, Level, Keyword)
// RegHandle : REGHANDLE -> 'int64_t'
// Level : BYTE -> 'uint8_t'
// Keyword : ULONGLONG -> 'uint64_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  EventProviderEnabled: { parameters: ["i64", "u8", "u64"], result: "u8" },
});
// lib.symbols.EventProviderEnabled(RegHandle, Level, Keyword)
// RegHandle : REGHANDLE -> "i64"
// Level : BYTE -> "u8"
// Keyword : ULONGLONG -> "u64"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint8_t EventProviderEnabled(
    int64_t RegHandle,
    uint8_t Level,
    uint64_t Keyword);
C, "ADVAPI32.dll");
// $ffi->EventProviderEnabled(RegHandle, Level, Keyword);
// RegHandle : REGHANDLE
// Level : BYTE
// Keyword : ULONGLONG
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
    byte EventProviderEnabled(
        long RegHandle,   // REGHANDLE
        byte Level,   // BYTE
        long Keyword   // ULONGLONG
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun EventProviderEnabled = EventProviderEnabled(
    RegHandle : Int64,   # REGHANDLE
    Level : UInt8,   # BYTE
    Keyword : UInt64   # ULONGLONG
  ) : UInt8
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EventProviderEnabledNative = Uint8 Function(Int64, Uint8, Uint64);
typedef EventProviderEnabledDart = int Function(int, int, int);
final EventProviderEnabled = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<EventProviderEnabledNative, EventProviderEnabledDart>('EventProviderEnabled');
// RegHandle : REGHANDLE -> Int64
// Level : BYTE -> Uint8
// Keyword : ULONGLONG -> Uint64
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EventProviderEnabled(
  RegHandle: Int64;   // REGHANDLE
  Level: Byte;   // BYTE
  Keyword: UInt64   // ULONGLONG
): ByteBool; stdcall;
  external 'ADVAPI32.dll' name 'EventProviderEnabled';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EventProviderEnabled"
  c_EventProviderEnabled :: Int64 -> Word8 -> Word64 -> IO Word8
-- RegHandle : REGHANDLE -> Int64
-- Level : BYTE -> Word8
-- Keyword : ULONGLONG -> Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let eventproviderenabled =
  foreign "EventProviderEnabled"
    (int64_t @-> uint8_t @-> uint64_t @-> returning uint8_t)
(* RegHandle : REGHANDLE -> int64_t *)
(* Level : BYTE -> uint8_t *)
(* Keyword : ULONGLONG -> uint64_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("EventProviderEnabled" event-provider-enabled :convention :stdcall) :uint8
  (reg-handle :int64)   ; REGHANDLE
  (level :uint8)   ; BYTE
  (keyword :uint64))   ; ULONGLONG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EventProviderEnabled = Win32::API::More->new('ADVAPI32',
    'BYTE EventProviderEnabled(INT64 RegHandle, BYTE Level, UINT64 Keyword)');
# my $ret = $EventProviderEnabled->Call($RegHandle, $Level, $Keyword);
# RegHandle : REGHANDLE -> INT64
# Level : BYTE -> BYTE
# Keyword : ULONGLONG -> UINT64
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。