ホーム › System.Diagnostics.Etw › ProcessTraceBufferIncrementReference

ProcessTraceBufferIncrementReference

関数

処理中のトレースバッファの参照カウントを増加させる。

DLLADVAPI32.dll呼出規約winapi

シグネチャ

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

DWORD ProcessTraceBufferIncrementReference(
    PROCESSTRACE_HANDLE TraceHandle,
    const ETW_BUFFER_HEADER* Buffer
);

パラメーター

名前	型	方向	説明
TraceHandle	PROCESSTRACE_HANDLE	in	この Buffer の取得元となった処理セッション。
Buffer	ETW_BUFFER_HEADER*	in	参照するバッファ。このバッファは PETW_BUFFER_CALLBACK コールバックの呼び出しによって取得されたものである必要があります。

戻り値の型: DWORD

公式ドキュメント

BufferCallback の実行中に、指定された Buffer に対して呼び出し、呼び出し元が処理を終えるまでそのバッファが解放されないようにします。

戻り値

Win32 エラーコード。返される可能性のあるコードには ERROR_INVALID_PARAMETER および ERROR_OUTOFMEMORY が含まれます。

解説(Remarks)

PETW_BUFFER_CALLBACK の実行中に ProcessTraceBufferIncrementReference が Buffer に対して呼び出されない場合、PETW_BUFFER_CALLBACK が戻った後はそのメモリにアクセスできなくなります。

呼び出し元は、Buffer の処理を終えた後に ProcessTraceBufferDecrementReference を呼び出す責任があります。ProcessTrace は、参照カウントをインクリメントしたすべてのバッファに対してこの処理が完了するまで戻りません。

ProcessTraceBufferIncrementReference は、OpenTraceFromBufferStream で開かれた処理セッションが提供するバッファではサポートされません。

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

各言語での呼び出し定義

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

DWORD ProcessTraceBufferIncrementReference(
    PROCESSTRACE_HANDLE TraceHandle,
    const ETW_BUFFER_HEADER* Buffer
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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