ホーム › System.Diagnostics.Etw › EnumerateTraceGuids

EnumerateTraceGuids

関数

システムに登録されているトレースGUIDを列挙する。

DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

WIN32_ERROR EnumerateTraceGuids(
    TRACE_GUID_PROPERTIES** GuidPropertiesArray,
    DWORD PropertyArrayCount,
    DWORD* GuidCount
);

パラメーター

名前	型	方向	説明
GuidPropertiesArray	TRACE_GUID_PROPERTIES**	inout	TRACE_GUID_PROPERTIES 構造体へのポインターの配列。配列内の各ポインターは、 TRACE_GUID_PROPERTIES 構造体を格納できる十分な領域を持つバッファーを指している必要があります。
PropertyArrayCount	DWORD	in	GuidPropertiesArray 配列内のポインターの数。
GuidCount	DWORD*	out	コンピューターに登録されているイベントトレースプロバイダーの実際の数を受け取ります。

戻り値の型: WIN32_ERROR

公式ドキュメント

現在実行中のイベントトレースプロバイダーに関する情報を取得します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値はシステムエラーコードのいずれかです。以下は一般的なエラーとその原因です。

ERROR_INVALID_PARAMETER

次のいずれかに該当します。
- PropertyArrayCount が 0 である
- GuidPropertiesArray が NULL である
ERROR_MORE_DATA

プロパティ配列が小さすぎて、登録されているすべてのプロバイダーの情報を受け取れません (GuidCount が PropertyArrayCount より大きい)。この関数は PropertyArrayCount で指定された数の構造体を GuidPropertiesArray に格納します。

解説(Remarks)

この関数は、開始済み (RegisterTraceGuids、 EventRegister を介して) でまだ停止されていないイベントトレースプロバイダーに関する情報を返します。

メモ

システムに登録されているプロバイダーのマニフェスト (すなわち wevtutil を介して登録されたマニフェスト) に関する情報を取得するには、 TdhEnumerateProviders を使用してください。

TRACE_GUID_PROPERTIES.IsEnable が TRUE の場合、 TRACE_GUID_PROPERTIES.LoggerId メンバーを使用して、どのセッションが最後にそのプロバイダーを有効化したかを判別できます。

この一覧には SystemTraceProvider プロバイダーは含まれません。

例

次の例は、この関数を呼び出す方法を示しています。

#include <windows.h>
#include <evntrace.h>
#include <vector>
#include <stdio.h>

int
wmain()
{
    ULONG status = 0;

    try
    {
        ULONG guidCount;
        std::vector<TRACE_GUID_PROPERTIES> guidPropValues;
        std::vector<TRACE_GUID_PROPERTIES*> guidPropPointers;

        // First call is just to get the actual count, so allocate a small buffer.
        guidCount = 1;

        // May need to retry multiple times since new providers could be added
        // between calls.
        for (;;)
        {
            ULONG const allocated = guidCount;
            guidPropValues.resize(allocated);
            guidPropPointers.resize(allocated);

            // Initialize the pointers to point at the values.
            for (ULONG i = 0; i != allocated; i += 1)
            {
                guidPropPointers[i] = &guidPropValues[i];
            }

            guidCount = 0;
            status = EnumerateTraceGuids(guidPropPointers.data(), allocated, &guidCount);
            if (status != ERROR_MORE_DATA)
            {
                guidPropValues.resize(guidCount);
                break;
            }

        }

        if (status != ERROR_SUCCESS)
        {
            printf("EnumerateTraceGuids error: %u\n", status);
        }
        else
        {
            printf("GuidCount = %lu\n", guidCount);
            for (auto const& v : guidPropValues)
            {
                printf("%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x - %hs\n",
                    v.Guid.Data1, v.Guid.Data2, v.Guid.Data3,
                    v.Guid.Data4[0], v.Guid.Data4[1],
                    v.Guid.Data4[2], v.Guid.Data4[3], v.Guid.Data4[4],
                    v.Guid.Data4[5], v.Guid.Data4[6], v.Guid.Data4[7],
                    v.IsEnable ? "Enabled" : "Disabled");
            }
        }
    }
    catch (std::bad_alloc const&)
    {
        printf("Out of memory!\n");
        status = ERROR_OUTOFMEMORY;
    }

    return status;
}

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

各言語での呼び出し定義

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

WIN32_ERROR EnumerateTraceGuids(
    TRACE_GUID_PROPERTIES** GuidPropertiesArray,
    DWORD PropertyArrayCount,
    DWORD* GuidCount
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint EnumerateTraceGuids(
    IntPtr GuidPropertiesArray,   // TRACE_GUID_PROPERTIES** in/out
    uint PropertyArrayCount,   // DWORD
    out uint GuidCount   // DWORD* out
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function EnumerateTraceGuids(
    GuidPropertiesArray As IntPtr,   ' TRACE_GUID_PROPERTIES** in/out
    PropertyArrayCount As UInteger,   ' DWORD
    <Out> ByRef GuidCount As UInteger   ' DWORD* out
) As UInteger
End Function

' GuidPropertiesArray : TRACE_GUID_PROPERTIES** in/out
' PropertyArrayCount : DWORD
' GuidCount : DWORD* out
Declare PtrSafe Function EnumerateTraceGuids Lib "advapi32" ( _
    ByVal GuidPropertiesArray As LongPtr, _
    ByVal PropertyArrayCount As Long, _
    ByRef GuidCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EnumerateTraceGuids = ctypes.windll.advapi32.EnumerateTraceGuids
EnumerateTraceGuids.restype = wintypes.DWORD
EnumerateTraceGuids.argtypes = [
    ctypes.c_void_p,  # GuidPropertiesArray : TRACE_GUID_PROPERTIES** in/out
    wintypes.DWORD,  # PropertyArrayCount : DWORD
    ctypes.POINTER(wintypes.DWORD),  # GuidCount : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
EnumerateTraceGuids = Fiddle::Function.new(
  lib['EnumerateTraceGuids'],
  [
    Fiddle::TYPE_VOIDP,  # GuidPropertiesArray : TRACE_GUID_PROPERTIES** in/out
    -Fiddle::TYPE_INT,  # PropertyArrayCount : DWORD
    Fiddle::TYPE_VOIDP,  # GuidCount : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn EnumerateTraceGuids(
        GuidPropertiesArray: *mut *mut TRACE_GUID_PROPERTIES,  // TRACE_GUID_PROPERTIES** in/out
        PropertyArrayCount: u32,  // DWORD
        GuidCount: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint EnumerateTraceGuids(IntPtr GuidPropertiesArray, uint PropertyArrayCount, out uint GuidCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_EnumerateTraceGuids' -Namespace Win32 -PassThru
# $api::EnumerateTraceGuids(GuidPropertiesArray, PropertyArrayCount, GuidCount)

#uselib "ADVAPI32.dll"
#func global EnumerateTraceGuids "EnumerateTraceGuids" sptr, sptr, sptr
; EnumerateTraceGuids varptr(GuidPropertiesArray), PropertyArrayCount, varptr(GuidCount)   ; 戻り値は stat
; GuidPropertiesArray : TRACE_GUID_PROPERTIES** in/out -> "sptr"
; PropertyArrayCount : DWORD -> "sptr"
; GuidCount : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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