ホーム › System.Diagnostics.Etw › TdhQueryProviderFieldInformation

TdhQueryProviderFieldInformation

関数

プロバイダーの特定フィールド値に関する情報を照会する。

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

シグネチャ

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

DWORD TdhQueryProviderFieldInformation(
    GUID* pGuid,
    ULONGLONG EventFieldValue,
    EVENT_FIELD_TYPE EventFieldType,
    PROVIDER_FIELD_INFOARRAY* pBuffer,   // optional
    DWORD* pBufferSize
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

指定した値に一致するフィールド値について、イベント記述から指定フィールドの情報を取得します。

戻り値

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

戻りコード	説明
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 クラスを使用して情報を取得します。

例

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

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

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

DWORD QueryFieldInfo(LPGUID pProvider, EVENT_FIELD_TYPE fieldType, ULONGLONG fieldValue);

// 列挙対象とするメタデータを持つプロバイダーの GUID。

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;

    // 値が 17 のチャネルがプロバイダーに定義されている場合、そのチャネル情報を取得する。
    // チャネルが存在する場合は 1 エントリを返す。

    wprintf(L"Retrieve EventChannelInformation for channel value 17.\n");

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

    // 値が 2 または 8 のキーワードについて、キーワード情報を取得する。

    wprintf(L"Retrieve EventKeywordInformation for keywords 2 and 8.\n");

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

// 指定したフィールドの型に関連付けられた情報を出力する。
DWORD QueryFieldInfo(LPGUID pProvider, EVENT_FIELD_TYPE fieldType, ULONGLONG fieldValue)
{
    DWORD status = ERROR_SUCCESS;
    PROVIDER_FIELD_INFOARRAY* penum = NULL;
    DWORD bufferSize = 0;

    // 必要なバッファーサイズを取得する。status が ERROR_INSUFFICIENT_BUFFER の場合、
    // bufferSize を使用してバッファーを割り当てる。

    status = TdhQueryProviderFieldInformation(pProvider, fieldValue, 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;
        }

        // フィールドの型と値について情報を取得する。

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

    // プロバイダーのイベント記述のいずれにも要求されたフィールド型の情報が含まれていない場合、
    // 最初の呼び出しは ERROR_NOT_FOUND で失敗することがある。

    if (ERROR_SUCCESS == status)
    {
        // フィールド情報のリストをループし、フィールドの名前、説明(存在する場合)、
        // および値を出力する。

        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"TdhQueryProviderFieldInformation 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 TdhQueryProviderFieldInformation(
    GUID* pGuid,
    ULONGLONG EventFieldValue,
    EVENT_FIELD_TYPE EventFieldType,
    PROVIDER_FIELD_INFOARRAY* pBuffer,   // optional
    DWORD* pBufferSize
);

[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhQueryProviderFieldInformation(
    ref Guid pGuid,   // GUID*
    ulong EventFieldValue,   // ULONGLONG
    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 TdhQueryProviderFieldInformation(
    ByRef pGuid As Guid,   ' GUID*
    EventFieldValue As ULong,   ' ULONGLONG
    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*
' EventFieldValue : ULONGLONG
' EventFieldType : EVENT_FIELD_TYPE
' pBuffer : PROVIDER_FIELD_INFOARRAY* optional, out
' pBufferSize : DWORD* in/out
Declare PtrSafe Function TdhQueryProviderFieldInformation Lib "tdh" ( _
    ByVal pGuid As LongPtr, _
    ByVal EventFieldValue As LongLong, _
    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

TdhQueryProviderFieldInformation = ctypes.windll.tdh.TdhQueryProviderFieldInformation
TdhQueryProviderFieldInformation.restype = wintypes.DWORD
TdhQueryProviderFieldInformation.argtypes = [
    ctypes.c_void_p,  # pGuid : GUID*
    ctypes.c_ulonglong,  # EventFieldValue : ULONGLONG
    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')
TdhQueryProviderFieldInformation = Fiddle::Function.new(
  lib['TdhQueryProviderFieldInformation'],
  [
    Fiddle::TYPE_VOIDP,  # pGuid : GUID*
    -Fiddle::TYPE_LONG_LONG,  # EventFieldValue : ULONGLONG
    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 TdhQueryProviderFieldInformation(
        pGuid: *mut GUID,  // GUID*
        EventFieldValue: u64,  // ULONGLONG
        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 TdhQueryProviderFieldInformation(ref Guid pGuid, ulong EventFieldValue, int EventFieldType, IntPtr pBuffer, ref uint pBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhQueryProviderFieldInformation' -Namespace Win32 -PassThru
# $api::TdhQueryProviderFieldInformation(pGuid, EventFieldValue, EventFieldType, pBuffer, pBufferSize)

#uselib "TDH.dll"
#func global TdhQueryProviderFieldInformation "TdhQueryProviderFieldInformation" sptr, sptr, sptr, sptr, sptr
; TdhQueryProviderFieldInformation varptr(pGuid), EventFieldValue, EventFieldType, varptr(pBuffer), varptr(pBufferSize)   ; 戻り値は stat
; pGuid : GUID* -> "sptr"
; EventFieldValue : ULONGLONG -> "sptr"
; EventFieldType : EVENT_FIELD_TYPE -> "sptr"
; pBuffer : PROVIDER_FIELD_INFOARRAY* optional, out -> "sptr"
; pBufferSize : DWORD* in/out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TDH.dll"
#cfunc global TdhQueryProviderFieldInformation "TdhQueryProviderFieldInformation" var, int64, int, var, var
; res = TdhQueryProviderFieldInformation(pGuid, EventFieldValue, EventFieldType, pBuffer, pBufferSize)
; pGuid : GUID* -> "var"
; EventFieldValue : ULONGLONG -> "int64"
; EventFieldType : EVENT_FIELD_TYPE -> "int"
; pBuffer : PROVIDER_FIELD_INFOARRAY* optional, out -> "var"
; pBufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "TDH.dll"
#cfunc global TdhQueryProviderFieldInformation "TdhQueryProviderFieldInformation" sptr, int64, int, sptr, sptr
; res = TdhQueryProviderFieldInformation(varptr(pGuid), EventFieldValue, EventFieldType, varptr(pBuffer), varptr(pBufferSize))
; pGuid : GUID* -> "sptr"
; EventFieldValue : ULONGLONG -> "int64"
; EventFieldType : EVENT_FIELD_TYPE -> "int"
; pBuffer : PROVIDER_FIELD_INFOARRAY* optional, out -> "sptr"
; pBufferSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。