ホーム › System.Diagnostics.Etw › CreateTraceInstanceId

CreateTraceInstanceId

関数

イベントインスタンス用の一意なインスタンスIDを作成する。

DLLADVAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR CreateTraceInstanceId(
    HANDLE RegHandle,
    EVENT_INSTANCE_INFO* InstInfo
);

パラメーター

名前	型	方向	説明
RegHandle	HANDLE	in	登録済みのイベントトレースクラスへのハンドル。 RegisterTraceGuids 関数は、このハンドルを TRACE_GUID_REGISTRATION 構造体の RegHandle メンバーに返します。
InstInfo	EVENT_INSTANCE_INFO*	inout	EVENT_INSTANCE_INFO 構造体へのポインター。この構造体の InstanceId メンバーには、トランザクション識別子が格納されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

RegisterTraceGuids ベースの(「クラシック」)イベントプロバイダーは、次を使用します。

戻り値

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

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

ERROR_INVALID_PARAMETER

次のいずれかに該当します。
- RegHandle が NULL です。
- pInstInfo が NULL です。

解説(Remarks)

RegisterTraceGuids ベースの(「クラシック」)プロバイダーがこの関数を呼び出します。EventRegister ベースの(「クリムゾン」)プロバイダーで同様の機能を使用するには、 EventActivityIdControl を使用してください。

ETW はユーザーモードプロセス内で識別子を作成するため、異なるプロセスの異なるインスタンスに対して同じ番号を返す場合があります。InstanceId が ULONG の最大値に達すると、値は 1 から再び始まります。CreateTraceInstanceId 関数を呼び出せるのはユーザーモードプロバイダーのみです(ドライバーはこの関数を呼び出せません)。

例

CreateTraceInstanceId を使用する例については、 Tracing Event Instancesを参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CreateTraceInstanceId(
    HANDLE RegHandle,
    EVENT_INSTANCE_INFO* InstInfo
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint CreateTraceInstanceId(
    IntPtr RegHandle,   // HANDLE
    IntPtr InstInfo   // EVENT_INSTANCE_INFO* in/out
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function CreateTraceInstanceId(
    RegHandle As IntPtr,   ' HANDLE
    InstInfo As IntPtr   ' EVENT_INSTANCE_INFO* in/out
) As UInteger
End Function

' RegHandle : HANDLE
' InstInfo : EVENT_INSTANCE_INFO* in/out
Declare PtrSafe Function CreateTraceInstanceId Lib "advapi32" ( _
    ByVal RegHandle As LongPtr, _
    ByVal InstInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateTraceInstanceId = ctypes.windll.advapi32.CreateTraceInstanceId
CreateTraceInstanceId.restype = wintypes.DWORD
CreateTraceInstanceId.argtypes = [
    wintypes.HANDLE,  # RegHandle : HANDLE
    ctypes.c_void_p,  # InstInfo : EVENT_INSTANCE_INFO* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CreateTraceInstanceId = Fiddle::Function.new(
  lib['CreateTraceInstanceId'],
  [
    Fiddle::TYPE_VOIDP,  # RegHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # InstInfo : EVENT_INSTANCE_INFO* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CreateTraceInstanceId(
        RegHandle: *mut core::ffi::c_void,  // HANDLE
        InstInfo: *mut EVENT_INSTANCE_INFO  // EVENT_INSTANCE_INFO* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint CreateTraceInstanceId(IntPtr RegHandle, IntPtr InstInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CreateTraceInstanceId' -Namespace Win32 -PassThru
# $api::CreateTraceInstanceId(RegHandle, InstInfo)

#uselib "ADVAPI32.dll"
#func global CreateTraceInstanceId "CreateTraceInstanceId" sptr, sptr
; CreateTraceInstanceId RegHandle, varptr(InstInfo)   ; 戻り値は stat
; RegHandle : HANDLE -> "sptr"
; InstInfo : EVENT_INSTANCE_INFO* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CreateTraceInstanceId "CreateTraceInstanceId" sptr, var
; res = CreateTraceInstanceId(RegHandle, InstInfo)
; RegHandle : HANDLE -> "sptr"
; InstInfo : EVENT_INSTANCE_INFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CreateTraceInstanceId "CreateTraceInstanceId" sptr, sptr
; res = CreateTraceInstanceId(RegHandle, varptr(InstInfo))
; RegHandle : HANDLE -> "sptr"
; InstInfo : EVENT_INSTANCE_INFO* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。