ホーム › System.Diagnostics.Etw › TdhEnumerateProviderFilters

TdhEnumerateProviderFilters

関数

プロバイダーで利用可能なフィルター情報を列挙する。

DLLTDH.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

DWORD TdhEnumerateProviderFilters(
    GUID* Guid,
    DWORD TdhContextCount,
    TDH_CONTEXT* TdhContext,   // optional
    DWORD* FilterCount,
    PROVIDER_FILTER_INFO** Buffer,   // optional
    DWORD* BufferSize
);

パラメーター

名前	型	方向	説明
Guid	GUID*	in	フィルターを取得する対象のプロバイダーを識別する GUID です。
TdhContextCount	DWORD	in	使用されません。
TdhContext	TDH_CONTEXT*	inoptional	使用されません。
FilterCount	DWORD*	out	pBuffer バッファーに格納されるフィルター構造体の数です。pBuffer バッファーが不足している場合は 0 になります。
Buffer	PROVIDER_FILTER_INFO**	outoptional	フィルター情報を受け取るためにユーザーが割り当てるバッファーです。詳細については、PROVIDER_FILTER_INFO 構造体を参照してください。
BufferSize	DWORD*	inout	pBuffer バッファーのサイズ (バイト単位) です。関数が成功した場合、このパラメーターは使用されたバッファーのサイズを受け取ります。バッファーが小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFER を返し、このパラメーターに必要なバッファーサイズを設定します。入力時にバッファーサイズが 0 の場合、バッファーにはデータが返されず、このパラメーターは必要なバッファーサイズを受け取ります。

戻り値の型: DWORD

公式ドキュメント

指定したプロバイダーがマニフェストで定義したフィルターを列挙します。

戻り値

成功した場合は ERROR_SUCCESS を返します。それ以外の場合、この関数は他のコードに加えて次のいずれかの戻り値コードを返します。

戻り値コード	説明
ERROR_INSUFFICIENT_BUFFER	pBuffer バッファーのサイズが小さすぎます。pBufferSize に設定された必要なバッファーサイズを使用して、新しいバッファーを割り当ててください。
ERROR_NOT_FOUND	イベントのスキーマが見つかりませんでした。
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
ERROR_FILE_NOT_FOUND	マニフェスト内の resourceFileName 属性には、プロバイダーバイナリの場所が含まれています。マニフェストを登録すると、その場所がレジストリに書き込まれます。TDH は登録された場所に基づいてバイナリを見つけることができませんでした。

解説(Remarks)

この関数は XML マニフェストを使用して情報を取得します。

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

各言語での呼び出し定義

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

DWORD TdhEnumerateProviderFilters(
    GUID* Guid,
    DWORD TdhContextCount,
    TDH_CONTEXT* TdhContext,   // optional
    DWORD* FilterCount,
    PROVIDER_FILTER_INFO** Buffer,   // optional
    DWORD* BufferSize
);

[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhEnumerateProviderFilters(
    ref Guid Guid,   // GUID*
    uint TdhContextCount,   // DWORD
    IntPtr TdhContext,   // TDH_CONTEXT* optional
    out uint FilterCount,   // DWORD* out
    IntPtr Buffer,   // PROVIDER_FILTER_INFO** optional, out
    ref uint BufferSize   // DWORD* in/out
);

<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhEnumerateProviderFilters(
    ByRef Guid As Guid,   ' GUID*
    TdhContextCount As UInteger,   ' DWORD
    TdhContext As IntPtr,   ' TDH_CONTEXT* optional
    <Out> ByRef FilterCount As UInteger,   ' DWORD* out
    Buffer As IntPtr,   ' PROVIDER_FILTER_INFO** optional, out
    ByRef BufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' Guid : GUID*
' TdhContextCount : DWORD
' TdhContext : TDH_CONTEXT* optional
' FilterCount : DWORD* out
' Buffer : PROVIDER_FILTER_INFO** optional, out
' BufferSize : DWORD* in/out
Declare PtrSafe Function TdhEnumerateProviderFilters Lib "tdh" ( _
    ByVal Guid As LongPtr, _
    ByVal TdhContextCount As Long, _
    ByVal TdhContext As LongPtr, _
    ByRef FilterCount As Long, _
    ByVal Buffer As LongPtr, _
    ByRef BufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TdhEnumerateProviderFilters = ctypes.windll.tdh.TdhEnumerateProviderFilters
TdhEnumerateProviderFilters.restype = wintypes.DWORD
TdhEnumerateProviderFilters.argtypes = [
    ctypes.c_void_p,  # Guid : GUID*
    wintypes.DWORD,  # TdhContextCount : DWORD
    ctypes.c_void_p,  # TdhContext : TDH_CONTEXT* optional
    ctypes.POINTER(wintypes.DWORD),  # FilterCount : DWORD* out
    ctypes.c_void_p,  # Buffer : PROVIDER_FILTER_INFO** optional, out
    ctypes.POINTER(wintypes.DWORD),  # BufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TDH.dll')
TdhEnumerateProviderFilters = Fiddle::Function.new(
  lib['TdhEnumerateProviderFilters'],
  [
    Fiddle::TYPE_VOIDP,  # Guid : GUID*
    -Fiddle::TYPE_INT,  # TdhContextCount : DWORD
    Fiddle::TYPE_VOIDP,  # TdhContext : TDH_CONTEXT* optional
    Fiddle::TYPE_VOIDP,  # FilterCount : DWORD* out
    Fiddle::TYPE_VOIDP,  # Buffer : PROVIDER_FILTER_INFO** optional, out
    Fiddle::TYPE_VOIDP,  # BufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "tdh")]
extern "system" {
    fn TdhEnumerateProviderFilters(
        Guid: *mut GUID,  // GUID*
        TdhContextCount: u32,  // DWORD
        TdhContext: *mut TDH_CONTEXT,  // TDH_CONTEXT* optional
        FilterCount: *mut u32,  // DWORD* out
        Buffer: *mut *mut PROVIDER_FILTER_INFO,  // PROVIDER_FILTER_INFO** optional, out
        BufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TDH.dll")]
public static extern uint TdhEnumerateProviderFilters(ref Guid Guid, uint TdhContextCount, IntPtr TdhContext, out uint FilterCount, IntPtr Buffer, ref uint BufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhEnumerateProviderFilters' -Namespace Win32 -PassThru
# $api::TdhEnumerateProviderFilters(Guid, TdhContextCount, TdhContext, FilterCount, Buffer, BufferSize)

#uselib "TDH.dll"
#func global TdhEnumerateProviderFilters "TdhEnumerateProviderFilters" sptr, sptr, sptr, sptr, sptr, sptr
; TdhEnumerateProviderFilters varptr(Guid), TdhContextCount, varptr(TdhContext), varptr(FilterCount), varptr(Buffer), varptr(BufferSize)   ; 戻り値は stat
; Guid : GUID* -> "sptr"
; TdhContextCount : DWORD -> "sptr"
; TdhContext : TDH_CONTEXT* optional -> "sptr"
; FilterCount : DWORD* out -> "sptr"
; Buffer : PROVIDER_FILTER_INFO** optional, out -> "sptr"
; BufferSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TDH.dll"
#cfunc global TdhEnumerateProviderFilters "TdhEnumerateProviderFilters" var, int, var, var, var, var
; res = TdhEnumerateProviderFilters(Guid, TdhContextCount, TdhContext, FilterCount, Buffer, BufferSize)
; Guid : GUID* -> "var"
; TdhContextCount : DWORD -> "int"
; TdhContext : TDH_CONTEXT* optional -> "var"
; FilterCount : DWORD* out -> "var"
; Buffer : PROVIDER_FILTER_INFO** optional, out -> "var"
; BufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TDH.dll"
#cfunc global TdhEnumerateProviderFilters "TdhEnumerateProviderFilters" sptr, int, sptr, sptr, sptr, sptr
; res = TdhEnumerateProviderFilters(varptr(Guid), TdhContextCount, varptr(TdhContext), varptr(FilterCount), varptr(Buffer), varptr(BufferSize))
; Guid : GUID* -> "sptr"
; TdhContextCount : DWORD -> "int"
; TdhContext : TDH_CONTEXT* optional -> "sptr"
; FilterCount : DWORD* out -> "sptr"
; Buffer : PROVIDER_FILTER_INFO** optional, out -> "sptr"
; BufferSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。