ホーム › System.Diagnostics.Etw › OpenTraceFromRealTimeLoggerWithAllocationOptions

OpenTraceFromRealTimeLoggerWithAllocationOptions

関数

割り当てオプションを指定しリアルタイムロガーからトレースを開く。

DLLADVAPI32.dll呼出規約winapi

シグネチャ

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

PROCESSTRACE_HANDLE OpenTraceFromRealTimeLoggerWithAllocationOptions(
    LPCWSTR LoggerName,
    const ETW_OPEN_TRACE_OPTIONS* Options,
    UINT_PTR AllocationSize,
    HANDLE MemoryPartitionHandle,   // optional
    TRACE_LOGFILE_HEADER* LogFileHeader   // optional
);

パラメーター

名前	型	方向	説明
LoggerName	LPCWSTR	in	リアルタイムイベントトレースセッションの名前。ログファイルからデータを処理する場合は NULL を指定します。リアルタイムセッションからデータを取得するために OpenTraceFromRealTimeLoggerWithAllocationOptions を呼び出す場合は、このメンバーに値を指定してください。 OpenTraceFromRealTimeLoggerWithAllocationOptions を呼び出す際、LogFileHeader が非 NULL の場合、LoggerName は NULL でなければなりません。イベントをリアルタイムで取得できるのは、トレースコントローラーが EVENT_TRACE_PROPERTIES の LogFileMode メンバーに EVENT_TRACE_REAL_TIME_MODE フラグを設定している場合のみです。イベントをリアルタイムで取得できるのは、管理者権限を持つユーザー、Performance Log Users グループのユーザー、および LocalSystem、LocalService、NetworkService として実行されるアプリケーションのみです。制限付きユーザーにイベントをリアルタイムで取得する権限を付与するには、そのユーザーを Performance Log Users グループに追加するか、EventAccessControl を呼び出します。
Options	ETW_OPEN_TRACE_OPTIONS*	in	この処理セッションの構成オプション。詳細については ETW_OPEN_TRACE_OPTIONS を参照してください。
AllocationSize	UINT_PTR	in	処理中に ETW バッファーを格納するために事前割り当てされるメモリのサイズ (バイト単位)。割り当てを大きくすると、個別の割り当て/解放呼び出しの必要性が減りますが、その代わりにメモリ使用量が常に高くなります。この値は、基本的な動作に十分なメモリが確保されるよう、基となるリアルタイム ETW セッションの合計バッファー領域を最小値として上方に調整されます。0 の場合は既定のサイズが使用されます。
MemoryPartitionHandle	HANDLE	inoptional	この処理セッションのメモリ割り当てに使用するメモリパーティションのハンドル。NULL の場合は、プロセスのメモリパーティションが使用されます。詳細については MemExtendedParameterPartitionHandle を参照してください。
LogFileHeader	TRACE_LOGFILE_HEADER*	outoptional	ログファイルのヘッダー情報。詳細については TRACE_LOGFILE_HEADER を参照してください。

戻り値の型: PROCESSTRACE_HANDLE

公式ドキュメント

アクティブなリアルタイム ETW セッションにアタッチされたトレース処理セッションを作成します。

戻り値

この処理セッションを識別するために使用される TRACEHANDLE。通常、処理を開始するために ProcessTrace に、処理を終了するために CloseTrace に渡されます。

解説(Remarks)

返された TRACEHANDLE に対して ProcessTrace を呼び出すと、ETW セッションからバッファーがフラッシュされるたびにそれらを受け取り、ただちに処理を開始して、Options で指定されたコールバックを呼び出します。これは OpenTraceFromRealTime と同一ですが、処理セッションのメモリ割り当てをカスタマイズできる点が異なります。

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

各言語での呼び出し定義

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

PROCESSTRACE_HANDLE OpenTraceFromRealTimeLoggerWithAllocationOptions(
    LPCWSTR LoggerName,
    const ETW_OPEN_TRACE_OPTIONS* Options,
    UINT_PTR AllocationSize,
    HANDLE MemoryPartitionHandle,   // optional
    TRACE_LOGFILE_HEADER* LogFileHeader   // optional
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern PROCESSTRACE_HANDLE OpenTraceFromRealTimeLoggerWithAllocationOptions(
    [MarshalAs(UnmanagedType.LPWStr)] string LoggerName,   // LPCWSTR
    IntPtr Options,   // ETW_OPEN_TRACE_OPTIONS*
    UIntPtr AllocationSize,   // UINT_PTR
    IntPtr MemoryPartitionHandle,   // HANDLE optional
    IntPtr LogFileHeader   // TRACE_LOGFILE_HEADER* optional, out
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function OpenTraceFromRealTimeLoggerWithAllocationOptions(
    <MarshalAs(UnmanagedType.LPWStr)> LoggerName As String,   ' LPCWSTR
    Options As IntPtr,   ' ETW_OPEN_TRACE_OPTIONS*
    AllocationSize As UIntPtr,   ' UINT_PTR
    MemoryPartitionHandle As IntPtr,   ' HANDLE optional
    LogFileHeader As IntPtr   ' TRACE_LOGFILE_HEADER* optional, out
) As PROCESSTRACE_HANDLE
End Function

' LoggerName : LPCWSTR
' Options : ETW_OPEN_TRACE_OPTIONS*
' AllocationSize : UINT_PTR
' MemoryPartitionHandle : HANDLE optional
' LogFileHeader : TRACE_LOGFILE_HEADER* optional, out
Declare PtrSafe Function OpenTraceFromRealTimeLoggerWithAllocationOptions Lib "advapi32" ( _
    ByVal LoggerName As LongPtr, _
    ByVal Options As LongPtr, _
    ByVal AllocationSize As LongPtr, _
    ByVal MemoryPartitionHandle As LongPtr, _
    ByVal LogFileHeader As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

OpenTraceFromRealTimeLoggerWithAllocationOptions = ctypes.windll.advapi32.OpenTraceFromRealTimeLoggerWithAllocationOptions
OpenTraceFromRealTimeLoggerWithAllocationOptions.restype = ctypes.c_void_p
OpenTraceFromRealTimeLoggerWithAllocationOptions.argtypes = [
    wintypes.LPCWSTR,  # LoggerName : LPCWSTR
    ctypes.c_void_p,  # Options : ETW_OPEN_TRACE_OPTIONS*
    ctypes.c_size_t,  # AllocationSize : UINT_PTR
    wintypes.HANDLE,  # MemoryPartitionHandle : HANDLE optional
    ctypes.c_void_p,  # LogFileHeader : TRACE_LOGFILE_HEADER* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
OpenTraceFromRealTimeLoggerWithAllocationOptions = Fiddle::Function.new(
  lib['OpenTraceFromRealTimeLoggerWithAllocationOptions'],
  [
    Fiddle::TYPE_VOIDP,  # LoggerName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Options : ETW_OPEN_TRACE_OPTIONS*
    Fiddle::TYPE_UINTPTR_T,  # AllocationSize : UINT_PTR
    Fiddle::TYPE_VOIDP,  # MemoryPartitionHandle : HANDLE optional
    Fiddle::TYPE_VOIDP,  # LogFileHeader : TRACE_LOGFILE_HEADER* optional, out
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "advapi32")]
extern "system" {
    fn OpenTraceFromRealTimeLoggerWithAllocationOptions(
        LoggerName: *const u16,  // LPCWSTR
        Options: *const ETW_OPEN_TRACE_OPTIONS,  // ETW_OPEN_TRACE_OPTIONS*
        AllocationSize: usize,  // UINT_PTR
        MemoryPartitionHandle: *mut core::ffi::c_void,  // HANDLE optional
        LogFileHeader: *mut TRACE_LOGFILE_HEADER  // TRACE_LOGFILE_HEADER* optional, out
    ) -> PROCESSTRACE_HANDLE;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern PROCESSTRACE_HANDLE OpenTraceFromRealTimeLoggerWithAllocationOptions([MarshalAs(UnmanagedType.LPWStr)] string LoggerName, IntPtr Options, UIntPtr AllocationSize, IntPtr MemoryPartitionHandle, IntPtr LogFileHeader);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_OpenTraceFromRealTimeLoggerWithAllocationOptions' -Namespace Win32 -PassThru
# $api::OpenTraceFromRealTimeLoggerWithAllocationOptions(LoggerName, Options, AllocationSize, MemoryPartitionHandle, LogFileHeader)

#uselib "ADVAPI32.dll"
#func global OpenTraceFromRealTimeLoggerWithAllocationOptions "OpenTraceFromRealTimeLoggerWithAllocationOptions" sptr, sptr, sptr, sptr, sptr
; OpenTraceFromRealTimeLoggerWithAllocationOptions LoggerName, varptr(Options), AllocationSize, MemoryPartitionHandle, varptr(LogFileHeader)   ; 戻り値は stat
; LoggerName : LPCWSTR -> "sptr"
; Options : ETW_OPEN_TRACE_OPTIONS* -> "sptr"
; AllocationSize : UINT_PTR -> "sptr"
; MemoryPartitionHandle : HANDLE optional -> "sptr"
; LogFileHeader : TRACE_LOGFILE_HEADER* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global OpenTraceFromRealTimeLoggerWithAllocationOptions "OpenTraceFromRealTimeLoggerWithAllocationOptions" wstr, var, sptr, sptr, var
; res = OpenTraceFromRealTimeLoggerWithAllocationOptions(LoggerName, Options, AllocationSize, MemoryPartitionHandle, LogFileHeader)
; LoggerName : LPCWSTR -> "wstr"
; Options : ETW_OPEN_TRACE_OPTIONS* -> "var"
; AllocationSize : UINT_PTR -> "sptr"
; MemoryPartitionHandle : HANDLE optional -> "sptr"
; LogFileHeader : TRACE_LOGFILE_HEADER* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global OpenTraceFromRealTimeLoggerWithAllocationOptions "OpenTraceFromRealTimeLoggerWithAllocationOptions" wstr, sptr, sptr, sptr, sptr
; res = OpenTraceFromRealTimeLoggerWithAllocationOptions(LoggerName, varptr(Options), AllocationSize, MemoryPartitionHandle, varptr(LogFileHeader))
; LoggerName : LPCWSTR -> "wstr"
; Options : ETW_OPEN_TRACE_OPTIONS* -> "sptr"
; AllocationSize : UINT_PTR -> "sptr"
; MemoryPartitionHandle : HANDLE optional -> "sptr"
; LogFileHeader : TRACE_LOGFILE_HEADER* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。