ホーム › System.Diagnostics.Etw › QueryAllTracesW

QueryAllTracesW

関数

システム上の全トレースセッションのプロパティを列挙する(Unicode版)。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR QueryAllTracesW(
    EVENT_TRACE_PROPERTIES** PropertyArray,
    DWORD PropertyArrayCount,
    DWORD* LoggerCount
);

パラメーター

名前	型	方向	説明
PropertyArray	EVENT_TRACE_PROPERTIES**	out	イベントトレースセッションのセッションプロパティと統計情報を受け取る EVENT_TRACE_PROPERTIES 構造体へのポインターの配列です。設定する必要があるのは、 EVENT_TRACE_PROPERTIES 構造体の Wnode.BufferSize、LoggerNameOffset、LogFileNameOffset の各メンバーのみです。その他のメンバーはすべて 0 に設定してください。
PropertyArrayCount	DWORD	in	PropertyArray 配列内の構造体の数です。この値は、ETW がサポートするイベントトレースセッションの最大数である 64 以下である必要があります。 Windows 10: PropertyArrayCount は 64 より大きい場合があり、一部のシステムでは 64 を超えるトレースセッションをサポートすることがあります。
LoggerCount	DWORD*	out	コンピューター上で開始されているイベントトレースセッションの実際の数です。

名前

型

方向

説明

PropertyArray

EVENT_TRACE_PROPERTIES**

out

イベントトレースセッションのセッションプロパティと統計情報を受け取る EVENT_TRACE_PROPERTIES 構造体へのポインターの配列です。

設定する必要があるのは、 EVENT_TRACE_PROPERTIES 構造体の Wnode.BufferSize、LoggerNameOffset、LogFileNameOffset の各メンバーのみです。その他のメンバーはすべて 0 に設定してください。

PropertyArrayCount

DWORD

PropertyArray 配列内の構造体の数です。この値は、ETW がサポートするイベントトレースセッションの最大数である 64 以下である必要があります。

Windows 10: PropertyArrayCount は 64 より大きい場合があり、一部のシステムでは 64 を超えるトレースセッションをサポートすることがあります。

LoggerCount

DWORD*

out

コンピューター上で開始されているイベントトレースセッションの実際の数です。

戻り値の型: WIN32_ERROR

公式ドキュメント

QueryAllTracesW (Unicode) 関数 (evntrace.h) は、呼び出し元がクエリできるすべてのイベントトレースセッションのプロパティと統計情報を取得します。

戻り値

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

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

ERROR_INVALID_PARAMETER

次のいずれかが当てはまります。
- PropertyArrayCount が 0 であるか、サポートされるセッションの最大数を超えている
- PropertyArray が NULL である
ERROR_MORE_DATA

プロパティ配列が小さすぎて、すべてのセッションの情報を受け取れません (SessionCount が PropertyArrayCount より大きい)。この関数は、 PropertyArrayCount で指定された数のプロパティ構造体をプロパティ配列に格納します。

解説(Remarks)

この関数はイベントトレースコントローラーが呼び出します。

この関数は、呼び出し元がクエリする権限を持つトレースセッションを取得します。昇格された管理者特権で実行しているユーザー、Performance Log Users グループに属するユーザー、および LocalSystem、LocalService、NetworkService として実行されているサービスは、すべてのトレースセッションを表示できます。

この関数はプライベートログセッションを返しません。

単一のセッションの情報を取得するには、 ControlTrace 関数を使用し、ControlCode パラメーターを EVENT_TRACE_CONTROL_QUERY に設定します。

例

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

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

const unsigned MAX_SESSION_NAME_LEN = 1024;
const unsigned MAX_LOGFILE_PATH_LEN = 1024;
const unsigned PropertiesSize =
    sizeof(EVENT_TRACE_PROPERTIES) +
    (MAX_SESSION_NAME_LEN * sizeof(CHAR)) +
    (MAX_LOGFILE_PATH_LEN * sizeof(CHAR));

int main()
{
    ULONG status;
    std::vector<EVENT_TRACE_PROPERTIES*> sessions; // Array of pointers to property structures
    std::vector<BYTE> buffer;                      // Buffer that contains all the property structures
    ULONG sessionCount;                            // Actual number of sessions started on the computer

    // The size of the session name and log file name used by the
    // controllers are not known, therefore create a properties structure that allows
    // for the maximum size of both.

    try
    {
        sessionCount = 64; // Start with room for 64 sessions.
        do
        {
            sessions.resize(sessionCount);
            buffer.resize(PropertiesSize * sessionCount);

            for (size_t i = 0; i != sessions.size(); i += 1)
            {
                sessions[i] = (EVENT_TRACE_PROPERTIES*)&buffer[i * PropertiesSize];
                sessions[i]->Wnode.BufferSize = PropertiesSize;
                sessions[i]->LoggerNameOffset = sizeof(EVENT_TRACE_PROPERTIES);
                sessions[i]->LogFileNameOffset = sizeof(EVENT_TRACE_PROPERTIES) + (MAX_SESSION_NAME_LEN * sizeof(CHAR));
            }

            status = QueryAllTracesA(&sessions[0], sessionCount, &sessionCount);
        } while (status == ERROR_MORE_DATA);

        if (status != ERROR_SUCCESS)
        {
            printf("Error calling QueryAllTraces: %u\n", status);
        }
        else
        {
            printf("Actual session count: %u.\n\n", sessionCount);

            for (ULONG i = 0; i < sessionCount; i++)
            {
                WCHAR sessionGuid[50];
                (void)StringFromGUID2(sessions[i]->Wnode.Guid, sessionGuid, ARRAYSIZE(sessionGuid));

                printf(
                    "Session GUID: %ls\n"
                    "Session ID: %llu\n"
                    "Session name: %s\n"
                    "Log file: %s\n"
                    "min buffers: %u\n"
                    "max buffers: %u\n"
                    "buffers: %u\n"
                    "buffers written: %u\n"
                    "buffers lost: %u\n"
                    "events lost: %u\n"
                    "\n",
                    sessionGuid,
                    sessions[i]->Wnode.HistoricalContext,
                    (PCSTR)((LPCBYTE)sessions[i] + sessions[i]->LoggerNameOffset),
                    (PCSTR)((LPCBYTE)sessions[i] + sessions[i]->LogFileNameOffset),
                    sessions[i]->MinimumBuffers,
                    sessions[i]->MaximumBuffers,
                    sessions[i]->NumberOfBuffers,
                    sessions[i]->BuffersWritten,
                    sessions[i]->LogBuffersLost,
                    sessions[i]->EventsLost);
            }
        }
    }
    catch (std::bad_alloc const&)
    {
        printf("Error allocating memory for properties.\n");
        status = ERROR_OUTOFMEMORY;
    }

    return status;
}

メモ

evntrace.h ヘッダーは QueryAllTraces をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディングニュートラルなエイリアスの使用を、エンコーディングニュートラルでないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR QueryAllTracesW(
    EVENT_TRACE_PROPERTIES** PropertyArray,
    DWORD PropertyArrayCount,
    DWORD* LoggerCount
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint QueryAllTracesW(
    IntPtr PropertyArray,   // EVENT_TRACE_PROPERTIES** out
    uint PropertyArrayCount,   // DWORD
    out uint LoggerCount   // DWORD* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function QueryAllTracesW(
    PropertyArray As IntPtr,   ' EVENT_TRACE_PROPERTIES** out
    PropertyArrayCount As UInteger,   ' DWORD
    <Out> ByRef LoggerCount As UInteger   ' DWORD* out
) As UInteger
End Function

' PropertyArray : EVENT_TRACE_PROPERTIES** out
' PropertyArrayCount : DWORD
' LoggerCount : DWORD* out
Declare PtrSafe Function QueryAllTracesW Lib "advapi32" ( _
    ByVal PropertyArray As LongPtr, _
    ByVal PropertyArrayCount As Long, _
    ByRef LoggerCount As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

QueryAllTracesW = ctypes.windll.advapi32.QueryAllTracesW
QueryAllTracesW.restype = wintypes.DWORD
QueryAllTracesW.argtypes = [
    ctypes.c_void_p,  # PropertyArray : EVENT_TRACE_PROPERTIES** out
    wintypes.DWORD,  # PropertyArrayCount : DWORD
    ctypes.POINTER(wintypes.DWORD),  # LoggerCount : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
QueryAllTracesW = Fiddle::Function.new(
  lib['QueryAllTracesW'],
  [
    Fiddle::TYPE_VOIDP,  # PropertyArray : EVENT_TRACE_PROPERTIES** out
    -Fiddle::TYPE_INT,  # PropertyArrayCount : DWORD
    Fiddle::TYPE_VOIDP,  # LoggerCount : DWORD* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint QueryAllTracesW(IntPtr PropertyArray, uint PropertyArrayCount, out uint LoggerCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_QueryAllTracesW' -Namespace Win32 -PassThru
# $api::QueryAllTracesW(PropertyArray, PropertyArrayCount, LoggerCount)

#uselib "ADVAPI32.dll"
#func global QueryAllTracesW "QueryAllTracesW" wptr, wptr, wptr
; QueryAllTracesW varptr(PropertyArray), PropertyArrayCount, varptr(LoggerCount)   ; 戻り値は stat
; PropertyArray : EVENT_TRACE_PROPERTIES** out -> "wptr"
; PropertyArrayCount : DWORD -> "wptr"
; LoggerCount : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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