ホーム › System.Diagnostics.Etw › TdhEnumerateProvidersForDecodingSource

TdhEnumerateProvidersForDecodingSource

関数

デコードソース種別でフィルターしてプロバイダーを列挙する。

DLLTDH.dll呼出規約winapi

シグネチャ

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

DWORD TdhEnumerateProvidersForDecodingSource(
    DECODING_SOURCE filter,
    PROVIDER_ENUMERATION_INFO* buffer,   // optional
    DWORD bufferSize,
    DWORD* bufferRequired
);

パラメーター

名前	型	方向	説明
filter	DECODING_SOURCE	in	DECODING_SOURCE 列挙型の 1 つ以上の値。
buffer	PROVIDER_ENUMERATION_INFO*	outoptional	コンピューター上でイベントを公開的に定義しているプロバイダーの配列。詳細については、PROVIDER_ENUMERATION_INFO 構造体を参照してください。
bufferSize	DWORD	in	pBuffer バッファーのサイズ (バイト単位)。関数が成功した場合、このパラメーターは使用されたバッファーのサイズを受け取ります。バッファーが小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFER を返し、このパラメーターに必要なバッファーサイズを設定します。入力時にバッファーサイズが 0 の場合、バッファーにはデータが返されず、このパラメーターは必要なバッファーサイズを受け取ります。
bufferRequired	DWORD*	out	必要なバッファー。

戻り値の型: DWORD

公式ドキュメント

コンピューター上で MOF クラスまたはマニフェストファイルを登録しているプロバイダーの一覧を取得します。

戻り値

成功した場合は ERROR_SUCCESS を返します。それ以外の場合、この関数は以下の戻りコードのいずれか (またはその他) を返します。

戻りコード	説明
ERROR_INSUFFICIENT_BUFFER	pBuffer バッファーのサイズが小さすぎます。pBufferSize に設定された必要なバッファーサイズを使用して、新しいバッファーを割り当ててください。
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが有効ではありません。

解説(Remarks)

コンピューター上に登録されているすべてのプロバイダーを取得するには、TdhEnumerateProviders を使用してください。

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

各言語での呼び出し定義

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

DWORD TdhEnumerateProvidersForDecodingSource(
    DECODING_SOURCE filter,
    PROVIDER_ENUMERATION_INFO* buffer,   // optional
    DWORD bufferSize,
    DWORD* bufferRequired
);

[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhEnumerateProvidersForDecodingSource(
    int filter,   // DECODING_SOURCE
    IntPtr buffer,   // PROVIDER_ENUMERATION_INFO* optional, out
    uint bufferSize,   // DWORD
    out uint bufferRequired   // DWORD* out
);

<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhEnumerateProvidersForDecodingSource(
    filter As Integer,   ' DECODING_SOURCE
    buffer As IntPtr,   ' PROVIDER_ENUMERATION_INFO* optional, out
    bufferSize As UInteger,   ' DWORD
    <Out> ByRef bufferRequired As UInteger   ' DWORD* out
) As UInteger
End Function

' filter : DECODING_SOURCE
' buffer : PROVIDER_ENUMERATION_INFO* optional, out
' bufferSize : DWORD
' bufferRequired : DWORD* out
Declare PtrSafe Function TdhEnumerateProvidersForDecodingSource Lib "tdh" ( _
    ByVal filter As Long, _
    ByVal buffer As LongPtr, _
    ByVal bufferSize As Long, _
    ByRef bufferRequired As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TdhEnumerateProvidersForDecodingSource = ctypes.windll.tdh.TdhEnumerateProvidersForDecodingSource
TdhEnumerateProvidersForDecodingSource.restype = wintypes.DWORD
TdhEnumerateProvidersForDecodingSource.argtypes = [
    ctypes.c_int,  # filter : DECODING_SOURCE
    ctypes.c_void_p,  # buffer : PROVIDER_ENUMERATION_INFO* optional, out
    wintypes.DWORD,  # bufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # bufferRequired : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TDH.dll')
TdhEnumerateProvidersForDecodingSource = Fiddle::Function.new(
  lib['TdhEnumerateProvidersForDecodingSource'],
  [
    Fiddle::TYPE_INT,  # filter : DECODING_SOURCE
    Fiddle::TYPE_VOIDP,  # buffer : PROVIDER_ENUMERATION_INFO* optional, out
    -Fiddle::TYPE_INT,  # bufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # bufferRequired : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "tdh")]
extern "system" {
    fn TdhEnumerateProvidersForDecodingSource(
        filter: i32,  // DECODING_SOURCE
        buffer: *mut PROVIDER_ENUMERATION_INFO,  // PROVIDER_ENUMERATION_INFO* optional, out
        bufferSize: u32,  // DWORD
        bufferRequired: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TDH.dll")]
public static extern uint TdhEnumerateProvidersForDecodingSource(int filter, IntPtr buffer, uint bufferSize, out uint bufferRequired);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhEnumerateProvidersForDecodingSource' -Namespace Win32 -PassThru
# $api::TdhEnumerateProvidersForDecodingSource(filter, buffer, bufferSize, bufferRequired)

#uselib "TDH.dll"
#func global TdhEnumerateProvidersForDecodingSource "TdhEnumerateProvidersForDecodingSource" sptr, sptr, sptr, sptr
; TdhEnumerateProvidersForDecodingSource filter, varptr(buffer), bufferSize, varptr(bufferRequired)   ; 戻り値は stat
; filter : DECODING_SOURCE -> "sptr"
; buffer : PROVIDER_ENUMERATION_INFO* optional, out -> "sptr"
; bufferSize : DWORD -> "sptr"
; bufferRequired : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TDH.dll"
#cfunc global TdhEnumerateProvidersForDecodingSource "TdhEnumerateProvidersForDecodingSource" int, var, int, var
; res = TdhEnumerateProvidersForDecodingSource(filter, buffer, bufferSize, bufferRequired)
; filter : DECODING_SOURCE -> "int"
; buffer : PROVIDER_ENUMERATION_INFO* optional, out -> "var"
; bufferSize : DWORD -> "int"
; bufferRequired : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TDH.dll"
#cfunc global TdhEnumerateProvidersForDecodingSource "TdhEnumerateProvidersForDecodingSource" int, sptr, int, sptr
; res = TdhEnumerateProvidersForDecodingSource(filter, varptr(buffer), bufferSize, varptr(bufferRequired))
; filter : DECODING_SOURCE -> "int"
; buffer : PROVIDER_ENUMERATION_INFO* optional, out -> "sptr"
; bufferSize : DWORD -> "int"
; bufferRequired : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。