Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Etw › ProcessTrace

ProcessTrace

関数
開いたトレースを処理し、コールバックにイベントを順次配信する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR ProcessTrace(
    PROCESSTRACE_HANDLE* HandleArray,
    DWORD HandleCount,
    FILETIME* StartTime,   // optional
    FILETIME* EndTime   // optional
);

パラメーター

名前方向説明
HandleArrayPROCESSTRACE_HANDLE*in

以前の OpenTrace 関数の呼び出しによって取得した、トレース処理セッション ハンドルの配列へのポインター。

この配列には、最大 64 個のファイル処理セッションのハンドルを格納できます。または、1 個のリアルタイム処理セッションのハンドルを格納できます。この配列に、ファイル処理セッションのハンドルとリアルタイム処理セッションのハンドルの両方を格納することはできません。

HandleCountDWORDinHandleArray の要素数。
StartTimeFILETIME*inoptionalイベントを受信する期間の開始時刻を指定する、省略可能な FILETIME 構造体へのポインター。この関数は、StartTime より前のタイムスタンプを持つイベントを配信しません。
EndTimeFILETIME*inoptional

イベントを受信する期間の終了時刻を指定する、省略可能な FILETIME 構造体へのポインター。この関数は、EndTime より後のタイムスタンプを持つイベントを配信しません。

Windows Server 2003: この値は、リアルタイムのイベント配信では無視されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

1 つ以上のトレース処理セッションのイベントをコンシューマーに配信します。

戻り値

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

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

解説(Remarks)

トレース コンシューマーは、1 つ以上のトレース処理セッションのイベントを処理するためにこの関数を呼び出します。この関数は、処理が終了するまでブロックします。

ProcessTrace を呼び出す前に、OpenTrace を使用してトレース処理セッションのハンドルを開きます。

ProcessTrace 関数は、コンシューマーの BufferCallbackEventCallback、および EventRecordCallback コールバック関数を呼び出すことにより、セッションのイベントを配信します。

ProcessTrace 関数は、イベントのタイムスタンプに基づいて順序どおりにイベントを配信しようとします (つまり、古いものから新しいものへとイベントを配信しようとします)。特定の状況では、ProcessTrace がイベントを順不同で配信する場合があります。

ProcessTrace 関数は、すべてのイベントを配信するか、BufferCallback 関数が FALSE を返すか、または CloseTrace を呼び出すまで、スレッドをブロックします。さらに、コンシューマーがリアルタイムでイベントを消費している場合、ProcessTrace 関数は、コントローラーがトレース セッションを停止した後に戻ります。(関数が戻るまでに数秒の遅延が発生する場合があることに注意してください。)

Windows Server 2003: CloseTrace は、ProcessTrace が戻った後にのみ呼び出すことができます。

ProcessTrace を使用する例については、TdhFormatProperty を使用してイベント データを消費する を参照してください。

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

各言語での呼び出し定義

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

WIN32_ERROR ProcessTrace(
    PROCESSTRACE_HANDLE* HandleArray,
    DWORD HandleCount,
    FILETIME* StartTime,   // optional
    FILETIME* EndTime   // optional
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint ProcessTrace(
    IntPtr HandleArray,   // PROCESSTRACE_HANDLE*
    uint HandleCount,   // DWORD
    IntPtr StartTime,   // FILETIME* optional
    IntPtr EndTime   // FILETIME* optional
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function ProcessTrace(
    HandleArray As IntPtr,   ' PROCESSTRACE_HANDLE*
    HandleCount As UInteger,   ' DWORD
    StartTime As IntPtr,   ' FILETIME* optional
    EndTime As IntPtr   ' FILETIME* optional
) As UInteger
End Function
' HandleArray : PROCESSTRACE_HANDLE*
' HandleCount : DWORD
' StartTime : FILETIME* optional
' EndTime : FILETIME* optional
Declare PtrSafe Function ProcessTrace Lib "advapi32" ( _
    ByVal HandleArray As LongPtr, _
    ByVal HandleCount As Long, _
    ByVal StartTime As LongPtr, _
    ByVal EndTime As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ProcessTrace = ctypes.windll.advapi32.ProcessTrace
ProcessTrace.restype = wintypes.DWORD
ProcessTrace.argtypes = [
    ctypes.c_void_p,  # HandleArray : PROCESSTRACE_HANDLE*
    wintypes.DWORD,  # HandleCount : DWORD
    ctypes.c_void_p,  # StartTime : FILETIME* optional
    ctypes.c_void_p,  # EndTime : FILETIME* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
ProcessTrace = Fiddle::Function.new(
  lib['ProcessTrace'],
  [
    Fiddle::TYPE_VOIDP,  # HandleArray : PROCESSTRACE_HANDLE*
    -Fiddle::TYPE_INT,  # HandleCount : DWORD
    Fiddle::TYPE_VOIDP,  # StartTime : FILETIME* optional
    Fiddle::TYPE_VOIDP,  # EndTime : FILETIME* optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn ProcessTrace(
        HandleArray: *mut PROCESSTRACE_HANDLE,  // PROCESSTRACE_HANDLE*
        HandleCount: u32,  // DWORD
        StartTime: *mut FILETIME,  // FILETIME* optional
        EndTime: *mut FILETIME  // FILETIME* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint ProcessTrace(IntPtr HandleArray, uint HandleCount, IntPtr StartTime, IntPtr EndTime);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_ProcessTrace' -Namespace Win32 -PassThru
# $api::ProcessTrace(HandleArray, HandleCount, StartTime, EndTime)
#uselib "ADVAPI32.dll"
#func global ProcessTrace "ProcessTrace" sptr, sptr, sptr, sptr
; ProcessTrace varptr(HandleArray), HandleCount, varptr(StartTime), varptr(EndTime)   ; 戻り値は stat
; HandleArray : PROCESSTRACE_HANDLE* -> "sptr"
; HandleCount : DWORD -> "sptr"
; StartTime : FILETIME* optional -> "sptr"
; EndTime : FILETIME* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global ProcessTrace "ProcessTrace" var, int, var, var
; res = ProcessTrace(HandleArray, HandleCount, StartTime, EndTime)
; HandleArray : PROCESSTRACE_HANDLE* -> "var"
; HandleCount : DWORD -> "int"
; StartTime : FILETIME* optional -> "var"
; EndTime : FILETIME* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR ProcessTrace(PROCESSTRACE_HANDLE* HandleArray, DWORD HandleCount, FILETIME* StartTime, FILETIME* EndTime)
#uselib "ADVAPI32.dll"
#cfunc global ProcessTrace "ProcessTrace" var, int, var, var
; res = ProcessTrace(HandleArray, HandleCount, StartTime, EndTime)
; HandleArray : PROCESSTRACE_HANDLE* -> "var"
; HandleCount : DWORD -> "int"
; StartTime : FILETIME* optional -> "var"
; EndTime : FILETIME* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procProcessTrace = advapi32.NewProc("ProcessTrace")
)

// HandleArray (PROCESSTRACE_HANDLE*), HandleCount (DWORD), StartTime (FILETIME* optional), EndTime (FILETIME* optional)
r1, _, err := procProcessTrace.Call(
	uintptr(HandleArray),
	uintptr(HandleCount),
	uintptr(StartTime),
	uintptr(EndTime),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function ProcessTrace(
  HandleArray: Pointer;   // PROCESSTRACE_HANDLE*
  HandleCount: DWORD;   // DWORD
  StartTime: Pointer;   // FILETIME* optional
  EndTime: Pointer   // FILETIME* optional
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'ProcessTrace';
result := DllCall("ADVAPI32\ProcessTrace"
    , "Ptr", HandleArray   ; PROCESSTRACE_HANDLE*
    , "UInt", HandleCount   ; DWORD
    , "Ptr", StartTime   ; FILETIME* optional
    , "Ptr", EndTime   ; FILETIME* optional
    , "UInt")   ; return: WIN32_ERROR
●ProcessTrace(HandleArray, HandleCount, StartTime, EndTime) = DLL("ADVAPI32.dll", "dword ProcessTrace(void*, dword, void*, void*)")
# 呼び出し: ProcessTrace(HandleArray, HandleCount, StartTime, EndTime)
# HandleArray : PROCESSTRACE_HANDLE* -> "void*"
# HandleCount : DWORD -> "dword"
# StartTime : FILETIME* optional -> "void*"
# EndTime : FILETIME* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn ProcessTrace(
    HandleArray: [*c]PROCESSTRACE_HANDLE, // PROCESSTRACE_HANDLE*
    HandleCount: u32, // DWORD
    StartTime: [*c]FILETIME, // FILETIME* optional
    EndTime: [*c]FILETIME // FILETIME* optional
) callconv(std.os.windows.WINAPI) u32;
proc ProcessTrace(
    HandleArray: ptr PROCESSTRACE_HANDLE,  # PROCESSTRACE_HANDLE*
    HandleCount: uint32,  # DWORD
    StartTime: ptr FILETIME,  # FILETIME* optional
    EndTime: ptr FILETIME  # FILETIME* optional
): uint32 {.importc: "ProcessTrace", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint ProcessTrace(
    PROCESSTRACE_HANDLE* HandleArray,   // PROCESSTRACE_HANDLE*
    uint HandleCount,   // DWORD
    FILETIME* StartTime,   // FILETIME* optional
    FILETIME* EndTime   // FILETIME* optional
);
ccall((:ProcessTrace, "ADVAPI32.dll"), stdcall, UInt32,
      (Ptr{PROCESSTRACE_HANDLE}, UInt32, Ptr{FILETIME}, Ptr{FILETIME}),
      HandleArray, HandleCount, StartTime, EndTime)
# HandleArray : PROCESSTRACE_HANDLE* -> Ptr{PROCESSTRACE_HANDLE}
# HandleCount : DWORD -> UInt32
# StartTime : FILETIME* optional -> Ptr{FILETIME}
# EndTime : FILETIME* optional -> Ptr{FILETIME}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ProcessTrace(
    void* HandleArray,
    uint32_t HandleCount,
    void* StartTime,
    void* EndTime);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.ProcessTrace(HandleArray, HandleCount, StartTime, EndTime)
-- HandleArray : PROCESSTRACE_HANDLE*
-- HandleCount : DWORD
-- StartTime : FILETIME* optional
-- EndTime : FILETIME* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const ProcessTrace = lib.func('__stdcall', 'ProcessTrace', 'uint32_t', ['void *', 'uint32_t', 'void *', 'void *']);
// ProcessTrace(HandleArray, HandleCount, StartTime, EndTime)
// HandleArray : PROCESSTRACE_HANDLE* -> 'void *'
// HandleCount : DWORD -> 'uint32_t'
// StartTime : FILETIME* optional -> 'void *'
// EndTime : FILETIME* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  ProcessTrace: { parameters: ["pointer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.ProcessTrace(HandleArray, HandleCount, StartTime, EndTime)
// HandleArray : PROCESSTRACE_HANDLE* -> "pointer"
// HandleCount : DWORD -> "u32"
// StartTime : FILETIME* optional -> "pointer"
// EndTime : FILETIME* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ProcessTrace(
    void* HandleArray,
    uint32_t HandleCount,
    void* StartTime,
    void* EndTime);
C, "ADVAPI32.dll");
// $ffi->ProcessTrace(HandleArray, HandleCount, StartTime, EndTime);
// HandleArray : PROCESSTRACE_HANDLE*
// HandleCount : DWORD
// StartTime : FILETIME* optional
// EndTime : FILETIME* optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
    int ProcessTrace(
        Pointer HandleArray,   // PROCESSTRACE_HANDLE*
        int HandleCount,   // DWORD
        Pointer StartTime,   // FILETIME* optional
        Pointer EndTime   // FILETIME* optional
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun ProcessTrace = ProcessTrace(
    HandleArray : PROCESSTRACE_HANDLE*,   # PROCESSTRACE_HANDLE*
    HandleCount : UInt32,   # DWORD
    StartTime : FILETIME*,   # FILETIME* optional
    EndTime : FILETIME*   # FILETIME* optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ProcessTraceNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>);
typedef ProcessTraceDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final ProcessTrace = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<ProcessTraceNative, ProcessTraceDart>('ProcessTrace');
// HandleArray : PROCESSTRACE_HANDLE* -> Pointer<Void>
// HandleCount : DWORD -> Uint32
// StartTime : FILETIME* optional -> Pointer<Void>
// EndTime : FILETIME* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ProcessTrace(
  HandleArray: Pointer;   // PROCESSTRACE_HANDLE*
  HandleCount: DWORD;   // DWORD
  StartTime: Pointer;   // FILETIME* optional
  EndTime: Pointer   // FILETIME* optional
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'ProcessTrace';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ProcessTrace"
  c_ProcessTrace :: Ptr () -> Word32 -> Ptr () -> Ptr () -> IO Word32
-- HandleArray : PROCESSTRACE_HANDLE* -> Ptr ()
-- HandleCount : DWORD -> Word32
-- StartTime : FILETIME* optional -> Ptr ()
-- EndTime : FILETIME* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let processtrace =
  foreign "ProcessTrace"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* HandleArray : PROCESSTRACE_HANDLE* -> (ptr void) *)
(* HandleCount : DWORD -> uint32_t *)
(* StartTime : FILETIME* optional -> (ptr void) *)
(* EndTime : FILETIME* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("ProcessTrace" process-trace :convention :stdcall) :uint32
  (handle-array :pointer)   ; PROCESSTRACE_HANDLE*
  (handle-count :uint32)   ; DWORD
  (start-time :pointer)   ; FILETIME* optional
  (end-time :pointer))   ; FILETIME* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ProcessTrace = Win32::API::More->new('ADVAPI32',
    'DWORD ProcessTrace(LPVOID HandleArray, DWORD HandleCount, LPVOID StartTime, LPVOID EndTime)');
# my $ret = $ProcessTrace->Call($HandleArray, $HandleCount, $StartTime, $EndTime);
# HandleArray : PROCESSTRACE_HANDLE* -> LPVOID
# HandleCount : DWORD -> DWORD
# StartTime : FILETIME* optional -> LPVOID
# EndTime : FILETIME* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型