ホーム › System.Diagnostics.Etw › TdhEnumerateProviders

TdhEnumerateProviders

関数

システムに登録されているイベントプロバイダーを列挙する。

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

シグネチャ

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

DWORD TdhEnumerateProviders(
    PROVIDER_ENUMERATION_INFO* pBuffer,   // optional
    DWORD* pBufferSize
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

登録済みのイベントプロバイダーの数はこの関数の呼び出しの間に変動する可能性があるため、戻り値が ERROR_INSUFFICIENT_BUFFER でなくなるまで繰り返すループ内にこの関数を配置してください。

例

プロバイダーを列挙する方法を示す例については、Enumerating Providers を参照してください。

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

各言語での呼び出し定義

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

DWORD TdhEnumerateProviders(
    PROVIDER_ENUMERATION_INFO* pBuffer,   // optional
    DWORD* pBufferSize
);

[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhEnumerateProviders(
    IntPtr pBuffer,   // PROVIDER_ENUMERATION_INFO* optional, out
    ref uint pBufferSize   // DWORD* in/out
);

<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhEnumerateProviders(
    pBuffer As IntPtr,   ' PROVIDER_ENUMERATION_INFO* optional, out
    ByRef pBufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' pBuffer : PROVIDER_ENUMERATION_INFO* optional, out
' pBufferSize : DWORD* in/out
Declare PtrSafe Function TdhEnumerateProviders Lib "tdh" ( _
    ByVal pBuffer As LongPtr, _
    ByRef pBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TdhEnumerateProviders = ctypes.windll.tdh.TdhEnumerateProviders
TdhEnumerateProviders.restype = wintypes.DWORD
TdhEnumerateProviders.argtypes = [
    ctypes.c_void_p,  # pBuffer : PROVIDER_ENUMERATION_INFO* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pBufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TDH.dll')
TdhEnumerateProviders = Fiddle::Function.new(
  lib['TdhEnumerateProviders'],
  [
    Fiddle::TYPE_VOIDP,  # pBuffer : PROVIDER_ENUMERATION_INFO* optional, out
    Fiddle::TYPE_VOIDP,  # pBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "tdh")]
extern "system" {
    fn TdhEnumerateProviders(
        pBuffer: *mut PROVIDER_ENUMERATION_INFO,  // PROVIDER_ENUMERATION_INFO* optional, out
        pBufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TDH.dll")]
public static extern uint TdhEnumerateProviders(IntPtr pBuffer, ref uint pBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhEnumerateProviders' -Namespace Win32 -PassThru
# $api::TdhEnumerateProviders(pBuffer, pBufferSize)

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

出力引数:

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