ホーム › System.Diagnostics.Etw › TdhEnumerateProviderFieldInformation

TdhEnumerateProviderFieldInformation

関数

プロバイダーのフィールド情報を種別ごとに列挙する。

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

シグネチャ

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

DWORD TdhEnumerateProviderFieldInformation(
    GUID* pGuid,
    EVENT_FIELD_TYPE EventFieldType,
    PROVIDER_FIELD_INFOARRAY* pBuffer,   // optional
    DWORD* pBufferSize
);

パラメーター

名前	型	方向	説明
pGuid	GUID*	in	情報を取得する対象プロバイダーを識別する GUID。
EventFieldType	EVENT_FIELD_TYPE	in	情報を取得するフィールドの種類を指定します。指定可能な値については、EVENT_FIELD_TYPE 列挙体を参照してください。
pBuffer	PROVIDER_FIELD_INFOARRAY*	outoptional	フィールド情報を受け取る、ユーザーが割り当てたバッファー。詳細については、PROVIDER_FIELD_INFOARRAY 構造体を参照してください。
pBufferSize	DWORD*	inout	pBuffer バッファーのサイズ(バイト単位)。関数が成功した場合、このパラメーターには使用されたバッファーのサイズが格納されます。バッファーが小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFER を返し、このパラメーターに必要なバッファーサイズを設定します。入力時にバッファーサイズが 0 の場合、バッファーにはデータが返されず、このパラメーターには必要なバッファーサイズが格納されます。

戻り値の型: DWORD

公式ドキュメント

指定したプロバイダーについて、指定したフィールドメタデータを取得します。

戻り値

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

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

解説(Remarks)

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

Examples

次の例は、要求されたフィールドについて、マニフェストまたは MOF クラスに含まれる情報を列挙する方法を示しています。

#include <windows.h>
#include <stdio.h>
#include <wmistr.h>
#include <evntrace.h>
#include <tdh.h>

#pragma comment(lib, "tdh.lib")

DWORD EnumFieldInfo(LPGUID pProvider, EVENT_FIELD_TYPE fieldType);

// GUID of the provider whose metadata you want to enumerate.

EXTERN_C __declspec(selectany) const GUID ProviderGuid = {0xd8909c24, 0x5be9, 0x4502, {0x98, 0xca, 0xab, 0x7b, 0xdc, 0x24, 0x89, 0x9d}};

void wmain(void)
{
    DWORD status = ERROR_SUCCESS;

    // Retrieve the keyword information.

    wprintf(L"Retrieve EventKeywordInformation\n");

    status = EnumFieldInfo((LPGUID)&ProviderGuid, EventKeywordInformation);
    if (ERROR_SUCCESS != status)
    {
        wprintf(L"Failed to retrieve EventKeywordInformation (%lu).\n\n", status);
    }
}

// Prints the information associated with the specified field type.
DWORD EnumFieldInfo(LPGUID pProvider, EVENT_FIELD_TYPE fieldType)
{
    DWORD status = ERROR_SUCCESS;
    PROVIDER_FIELD_INFOARRAY* penum = NULL;
    DWORD bufferSize = 0;

    // Retrieve the required buffer size. If the status is ERROR_INSUFFICIENT_BUFFER,
    // use bufferSize to allocate the buffer.

    status = TdhEnumerateProviderFieldInformation(pProvider, fieldType, penum, &bufferSize);
    if (ERROR_INSUFFICIENT_BUFFER == status)
    {
        penum = (PROVIDER_FIELD_INFOARRAY*) malloc(bufferSize);
        if (penum == NULL)
        {
            wprintf(L"Allocation failed (size=%lu).\n", bufferSize);
            status = ERROR_OUTOFMEMORY;
            goto cleanup;
        }

        // Retrieve the information for the field type.

        status = TdhEnumerateProviderFieldInformation(pProvider, fieldType, penum, &bufferSize);
    }

    // The first call can fail with ERROR_NOT_FOUND if none of the provider's event
    // descriptions contain the requested field type information.

    if (ERROR_SUCCESS == status)
    {
        // Loop through the list of field information and print the field's name,
        // description (if it exists), and value. 

        for (DWORD i = 0; i < penum->NumberOfElements; i++)
        {
            wprintf(L"Field name: %s\nDescription: %s\nValue: %I64u\n\n",
                (PWCHAR)((PBYTE)(penum) + penum->FieldInfoArray[i].NameOffset),
                (penum->FieldInfoArray[i].DescriptionOffset) ? 
                    (PWCHAR)((PBYTE)(penum) + penum->FieldInfoArray[i].DescriptionOffset): L"",
                penum->FieldInfoArray[i].Value);
        }
    }
    else
    {
        if (ERROR_NOT_FOUND == status)
        {
            wprintf(L"Requested field type not found.\n");
        }
        else
        {
            wprintf(L"TdhEnumerateProviderFieldInformation failed with %lu.\n", status);
        }

        goto cleanup;
    }

cleanup:

    if (penum)
    {
        free(penum);
        penum = NULL;
    }

    return status;
}

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

各言語での呼び出し定義

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

DWORD TdhEnumerateProviderFieldInformation(
    GUID* pGuid,
    EVENT_FIELD_TYPE EventFieldType,
    PROVIDER_FIELD_INFOARRAY* pBuffer,   // optional
    DWORD* pBufferSize
);

[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhEnumerateProviderFieldInformation(
    ref Guid pGuid,   // GUID*
    int EventFieldType,   // EVENT_FIELD_TYPE
    IntPtr pBuffer,   // PROVIDER_FIELD_INFOARRAY* optional, out
    ref uint pBufferSize   // DWORD* in/out
);

<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhEnumerateProviderFieldInformation(
    ByRef pGuid As Guid,   ' GUID*
    EventFieldType As Integer,   ' EVENT_FIELD_TYPE
    pBuffer As IntPtr,   ' PROVIDER_FIELD_INFOARRAY* optional, out
    ByRef pBufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' pGuid : GUID*
' EventFieldType : EVENT_FIELD_TYPE
' pBuffer : PROVIDER_FIELD_INFOARRAY* optional, out
' pBufferSize : DWORD* in/out
Declare PtrSafe Function TdhEnumerateProviderFieldInformation Lib "tdh" ( _
    ByVal pGuid As LongPtr, _
    ByVal EventFieldType As Long, _
    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

TdhEnumerateProviderFieldInformation = ctypes.windll.tdh.TdhEnumerateProviderFieldInformation
TdhEnumerateProviderFieldInformation.restype = wintypes.DWORD
TdhEnumerateProviderFieldInformation.argtypes = [
    ctypes.c_void_p,  # pGuid : GUID*
    ctypes.c_int,  # EventFieldType : EVENT_FIELD_TYPE
    ctypes.c_void_p,  # pBuffer : PROVIDER_FIELD_INFOARRAY* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pBufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TDH.dll')
TdhEnumerateProviderFieldInformation = Fiddle::Function.new(
  lib['TdhEnumerateProviderFieldInformation'],
  [
    Fiddle::TYPE_VOIDP,  # pGuid : GUID*
    Fiddle::TYPE_INT,  # EventFieldType : EVENT_FIELD_TYPE
    Fiddle::TYPE_VOIDP,  # pBuffer : PROVIDER_FIELD_INFOARRAY* optional, out
    Fiddle::TYPE_VOIDP,  # pBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "tdh")]
extern "system" {
    fn TdhEnumerateProviderFieldInformation(
        pGuid: *mut GUID,  // GUID*
        EventFieldType: i32,  // EVENT_FIELD_TYPE
        pBuffer: *mut PROVIDER_FIELD_INFOARRAY,  // PROVIDER_FIELD_INFOARRAY* 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 TdhEnumerateProviderFieldInformation(ref Guid pGuid, int EventFieldType, IntPtr pBuffer, ref uint pBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhEnumerateProviderFieldInformation' -Namespace Win32 -PassThru
# $api::TdhEnumerateProviderFieldInformation(pGuid, EventFieldType, pBuffer, pBufferSize)

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

出力引数:

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