ホーム › System.Diagnostics.Etw › ProcessTraceAddBufferToBufferStream

ProcessTraceAddBufferToBufferStream

関数

トレースバッファをバッファストリームに追加して処理する。

DLLADVAPI32.dll呼出規約winapi

シグネチャ

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

DWORD ProcessTraceAddBufferToBufferStream(
    PROCESSTRACE_HANDLE TraceHandle,
    const ETW_BUFFER_HEADER* Buffer,
    DWORD BufferSize
);

パラメーター

名前	型	方向	説明
TraceHandle	PROCESSTRACE_HANDLE	in	バッファーを追加する処理セッションの TRACEHANDLE。
Buffer	ETW_BUFFER_HEADER*	in	処理対象の有効な ETW バッファー。
BufferSize	DWORD	in	ETW バッファーのサイズ。

戻り値の型: DWORD

公式ドキュメント

OpenTraceFromBufferStream で作成された処理セッションに ETW トレースバッファーを提供します。

戻り値

ERROR_SUCCESS、またはバッファーが無効である、時間順序が正しくない、もしくは TraceHandle が無効であることを示す Win32 エラーコード。

解説(Remarks)

ProcessTraceAddBufferToBufferStream に渡すバッファーは、ProcessTrace によって生成されたときと同じ順序でなければなりません。バッファーの順序が正しくない場合、この関数はエラーを返すことがあります。

バッファーの処理が完了すると、OpenTraceFromBufferStream で指定された BufferCompletionCallback が呼び出され、バッファーが解放されます。

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

各言語での呼び出し定義

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

DWORD ProcessTraceAddBufferToBufferStream(
    PROCESSTRACE_HANDLE TraceHandle,
    const ETW_BUFFER_HEADER* Buffer,
    DWORD BufferSize
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint ProcessTraceAddBufferToBufferStream(
    PROCESSTRACE_HANDLE TraceHandle,   // PROCESSTRACE_HANDLE
    IntPtr Buffer,   // ETW_BUFFER_HEADER*
    uint BufferSize   // DWORD
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function ProcessTraceAddBufferToBufferStream(
    TraceHandle As PROCESSTRACE_HANDLE,   ' PROCESSTRACE_HANDLE
    Buffer As IntPtr,   ' ETW_BUFFER_HEADER*
    BufferSize As UInteger   ' DWORD
) As UInteger
End Function

' TraceHandle : PROCESSTRACE_HANDLE
' Buffer : ETW_BUFFER_HEADER*
' BufferSize : DWORD
Declare PtrSafe Function ProcessTraceAddBufferToBufferStream Lib "advapi32" ( _
    ByVal TraceHandle As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByVal BufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ProcessTraceAddBufferToBufferStream = ctypes.windll.advapi32.ProcessTraceAddBufferToBufferStream
ProcessTraceAddBufferToBufferStream.restype = wintypes.DWORD
ProcessTraceAddBufferToBufferStream.argtypes = [
    PROCESSTRACE_HANDLE,  # TraceHandle : PROCESSTRACE_HANDLE
    ctypes.c_void_p,  # Buffer : ETW_BUFFER_HEADER*
    wintypes.DWORD,  # BufferSize : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
ProcessTraceAddBufferToBufferStream = Fiddle::Function.new(
  lib['ProcessTraceAddBufferToBufferStream'],
  [
    Fiddle::TYPE_VOIDP,  # TraceHandle : PROCESSTRACE_HANDLE
    Fiddle::TYPE_VOIDP,  # Buffer : ETW_BUFFER_HEADER*
    -Fiddle::TYPE_INT,  # BufferSize : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn ProcessTraceAddBufferToBufferStream(
        TraceHandle: PROCESSTRACE_HANDLE,  // PROCESSTRACE_HANDLE
        Buffer: *const ETW_BUFFER_HEADER,  // ETW_BUFFER_HEADER*
        BufferSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint ProcessTraceAddBufferToBufferStream(PROCESSTRACE_HANDLE TraceHandle, IntPtr Buffer, uint BufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_ProcessTraceAddBufferToBufferStream' -Namespace Win32 -PassThru
# $api::ProcessTraceAddBufferToBufferStream(TraceHandle, Buffer, BufferSize)

#uselib "ADVAPI32.dll"
#func global ProcessTraceAddBufferToBufferStream "ProcessTraceAddBufferToBufferStream" sptr, sptr, sptr
; ProcessTraceAddBufferToBufferStream TraceHandle, varptr(Buffer), BufferSize   ; 戻り値は stat
; TraceHandle : PROCESSTRACE_HANDLE -> "sptr"
; Buffer : ETW_BUFFER_HEADER* -> "sptr"
; BufferSize : DWORD -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global ProcessTraceAddBufferToBufferStream "ProcessTraceAddBufferToBufferStream" int, var, int
; res = ProcessTraceAddBufferToBufferStream(TraceHandle, Buffer, BufferSize)
; TraceHandle : PROCESSTRACE_HANDLE -> "int"
; Buffer : ETW_BUFFER_HEADER* -> "var"
; BufferSize : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global ProcessTraceAddBufferToBufferStream "ProcessTraceAddBufferToBufferStream" int, sptr, int
; res = ProcessTraceAddBufferToBufferStream(TraceHandle, varptr(Buffer), BufferSize)
; TraceHandle : PROCESSTRACE_HANDLE -> "int"
; Buffer : ETW_BUFFER_HEADER* -> "sptr"
; BufferSize : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。