ホーム › System.Diagnostics.Etw › OpenTraceFromBufferStream

OpenTraceFromBufferStream

関数

バッファストリームからトレースを消費用に開く。

DLLADVAPI32.dll呼出規約winapi

シグネチャ

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

PROCESSTRACE_HANDLE OpenTraceFromBufferStream(
    const ETW_OPEN_TRACE_OPTIONS* Options,
    PETW_BUFFER_COMPLETION_CALLBACK BufferCompletionCallback,
    void* BufferCompletionContext   // optional
);

パラメーター

名前	型	方向	説明
Options	ETW_OPEN_TRACE_OPTIONS*	in	この処理セッションの構成オプションです。詳細については ETW_OPEN_TRACE_OPTIONS を参照してください。
BufferCompletionCallback	PETW_BUFFER_COMPLETION_CALLBACK	in	処理セッションが ProcessTraceAddBufferToBufferStream から渡されたバッファーの処理を完了すると、このコールバックが呼び出され、そのバッファーに必要となる解放やその他のクリーンアップを行えます。
BufferCompletionContext	void*	inoptional	BufferCompletionCallback に渡される、ユーザー指定のコンテキストです。

戻り値の型: PROCESSTRACE_HANDLE

公式ドキュメント

いずれのファイルやアクティブなセッションにも直接アタッチされないトレース処理セッションを作成します。

戻り値

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

解説(Remarks)

呼び出し元は、ProcessTraceAddBufferToBufferStream を呼び出してトレースのデータを供給することが求められます。これは通常、リモートのリアルタイムトレース処理に使用されます。リモートシステムは OpenTraceFromRealTimeLogger と ProcessTrace を、バッファーをネットワーク経由でローカルシステムに送信する BufferCallback とともに使用します。次にローカルシステムは OpenTraceFromBufferStream と ProcessTrace を呼び出し、ネットワークからバッファーを受信して、ProcessTraceAddBufferToBufferStream を使用してローカルのトレースプロセッサに渡します。

この処理モードでは、バッファーは ProcessTrace から受信したのと同じ順序で提供する必要があります(たとえば、最初のバッファーにはヘッダー情報が含まれ、後続のバッファーはフラッシュ時刻順に並びます)。この方法でバッファーを生成する唯一のサポートされた手段は、別の OpenTraceFromBufferStream、OpenTraceFromFile、OpenTraceFromRealTimeLogger、OpenTraceFromRealTimeLoggerWithAllocationOptions 処理セッションの BufferCallback からのものです。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 OpenTraceFromBufferStream(
    const ETW_OPEN_TRACE_OPTIONS* Options,
    PETW_BUFFER_COMPLETION_CALLBACK BufferCompletionCallback,
    void* BufferCompletionContext   // optional
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern PROCESSTRACE_HANDLE OpenTraceFromBufferStream(
    IntPtr Options,   // ETW_OPEN_TRACE_OPTIONS*
    IntPtr BufferCompletionCallback,   // PETW_BUFFER_COMPLETION_CALLBACK
    IntPtr BufferCompletionContext   // void* optional
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function OpenTraceFromBufferStream(
    Options As IntPtr,   ' ETW_OPEN_TRACE_OPTIONS*
    BufferCompletionCallback As IntPtr,   ' PETW_BUFFER_COMPLETION_CALLBACK
    BufferCompletionContext As IntPtr   ' void* optional
) As PROCESSTRACE_HANDLE
End Function

' Options : ETW_OPEN_TRACE_OPTIONS*
' BufferCompletionCallback : PETW_BUFFER_COMPLETION_CALLBACK
' BufferCompletionContext : void* optional
Declare PtrSafe Function OpenTraceFromBufferStream Lib "advapi32" ( _
    ByVal Options As LongPtr, _
    ByVal BufferCompletionCallback As LongPtr, _
    ByVal BufferCompletionContext As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

OpenTraceFromBufferStream = ctypes.windll.advapi32.OpenTraceFromBufferStream
OpenTraceFromBufferStream.restype = ctypes.c_void_p
OpenTraceFromBufferStream.argtypes = [
    ctypes.c_void_p,  # Options : ETW_OPEN_TRACE_OPTIONS*
    ctypes.c_void_p,  # BufferCompletionCallback : PETW_BUFFER_COMPLETION_CALLBACK
    ctypes.POINTER(None),  # BufferCompletionContext : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
OpenTraceFromBufferStream = Fiddle::Function.new(
  lib['OpenTraceFromBufferStream'],
  [
    Fiddle::TYPE_VOIDP,  # Options : ETW_OPEN_TRACE_OPTIONS*
    Fiddle::TYPE_VOIDP,  # BufferCompletionCallback : PETW_BUFFER_COMPLETION_CALLBACK
    Fiddle::TYPE_VOIDP,  # BufferCompletionContext : void* optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "advapi32")]
extern "system" {
    fn OpenTraceFromBufferStream(
        Options: *const ETW_OPEN_TRACE_OPTIONS,  // ETW_OPEN_TRACE_OPTIONS*
        BufferCompletionCallback: *const core::ffi::c_void,  // PETW_BUFFER_COMPLETION_CALLBACK
        BufferCompletionContext: *mut ()  // void* optional
    ) -> PROCESSTRACE_HANDLE;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern PROCESSTRACE_HANDLE OpenTraceFromBufferStream(IntPtr Options, IntPtr BufferCompletionCallback, IntPtr BufferCompletionContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_OpenTraceFromBufferStream' -Namespace Win32 -PassThru
# $api::OpenTraceFromBufferStream(Options, BufferCompletionCallback, BufferCompletionContext)

#uselib "ADVAPI32.dll"
#func global OpenTraceFromBufferStream "OpenTraceFromBufferStream" sptr, sptr, sptr
; OpenTraceFromBufferStream varptr(Options), BufferCompletionCallback, BufferCompletionContext   ; 戻り値は stat
; Options : ETW_OPEN_TRACE_OPTIONS* -> "sptr"
; BufferCompletionCallback : PETW_BUFFER_COMPLETION_CALLBACK -> "sptr"
; BufferCompletionContext : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global OpenTraceFromBufferStream "OpenTraceFromBufferStream" var, sptr, sptr
; res = OpenTraceFromBufferStream(Options, BufferCompletionCallback, BufferCompletionContext)
; Options : ETW_OPEN_TRACE_OPTIONS* -> "var"
; BufferCompletionCallback : PETW_BUFFER_COMPLETION_CALLBACK -> "sptr"
; BufferCompletionContext : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global OpenTraceFromBufferStream "OpenTraceFromBufferStream" sptr, sptr, sptr
; res = OpenTraceFromBufferStream(varptr(Options), BufferCompletionCallback, BufferCompletionContext)
; Options : ETW_OPEN_TRACE_OPTIONS* -> "sptr"
; BufferCompletionCallback : PETW_BUFFER_COMPLETION_CALLBACK -> "sptr"
; BufferCompletionContext : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。