TraceLoggingValue マクロ (traceloggingprovider.h)

  • [アーティクル]

自動的に推測される型を持つフィールドをイベントに追加する C++ のトレース ログ ラッパー マクロ。

構文

void TraceLoggingValue(
  [in]            value,
  [in, optional]  __VA_ARGS__
);

パラメーター

[in] value

イベント フィールドの値。

[in, optional] __VA_ARGS__

フィールド定義の省略可能な 名前、 説明、 タグ パラメーター。

TraceLoggingValue は、1、2、3、または 4 つのパラメーターで指定できます。 パラメーターが指定されていない場合は、既定値が使用されます。 たとえば、TraceLoggingValue(a+b) は、TraceLoggingValue(a+b, "a+b", "", 0) と同じです。

  • [in, optional] name

    イベント フィールドに使用する名前。 指定する場合、name パラメーターは文字列リテラル (変数ではない) であり、'\0' 文字を含めてはなりません。 指定しない場合、イベント フィールド名は 値に基づいています。

  • [in, optional] description

    イベント フィールドの値の説明。 指定した場合、description パラメーターは文字列リテラルである必要があり、 PDB に含まれます。

  • [in, optional] tags

    コンパイル時の定数整数値。 値の下位 28 ビットは、フィールドのメタデータに含まれます。 この値のセマンティクスは、イベント コンシューマーによって定義されます。 イベント処理中に、この値は [EVENT_PROPERTY_INFO タグ] フィールドから取得できます。

戻り値

なし

解説

C++ コードでは、 TraceLoggingValue(value, ...) を TraceLoggingWrite マクロの呼び出しのパラメーターとして使用できます。 各 TraceLoggingValue パラメーターは、イベントに 1 つのフィールドを追加します。

ETW イベントのフィールドの型は、 値 式の型から自動的に推定されます。 値の型に基づいて、 TraceLoggingValue(value, ...) は、次のような標準の TraceLogging ラッパー マクロの 1 つと同じです。

値の型 相当する構文 メモ
bool TraceLoggingBoolean
char TraceLoggingChar char の場合のみ。符号付き char または符号なし char の場合は使用できません。
char16_t TraceLoggingChar16
wchar_t TraceLoggingWChar ネイティブ wchar_tの場合のみ。USHORT の場合は使用できません。
intNN_t TraceLoggingIntNN 符号付き char、short、int、long、long long の場合。
uintNN_t TraceLoggingUIntNN unsigned char、short、int、long、long long の場合。
float TraceLoggingFloat32
double TraceLoggingFloat64
GUID TraceLoggingGuid
FILETIME TraceLoggingFileTime
SYSTEMTIME TraceLoggingSystemTime
SID* TraceLoggingSid NULL 以外の値を指定し、有効な SIDを指す必要があります。
void* TraceLoggingPointer 参照されたデータではなく、ポインター値をログに記録します。
char* TraceLoggingString 0 で終わるCP_ACP文字列。 NULL は として ""扱われます。
char16_t* TraceLoggingString16 0 で終わる UTF-16 文字列。 NULL は として u""扱われます。
wchar_t* TraceLoggingWideString 0 で終わる UTF-16 文字列。 NULL は として L""扱われます。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー traceloggingprovider.h

こちらもご覧ください

TraceLoggingWrite

トレース ログ ラッパー マクロ