RECORDER_LOG_CREATE_PARAMS 構造体 (wpprecorder.h)

  • [アーティクル]

RECORDER_LOG_CREATE_PARAMS構造体は、WppRecorderLogCreate メソッドへの入力パラメーターです。

構文

typedef struct _RECORDER_LOG_CREATE_PARAMS {
  ULONG                  Size;
  ULONG                  LogTag;
  ULONG                  TotalBufferSize;
  ULONG                  ErrorPartitionSize;
  ULONG_PTR              LogIdentifierAppendValue;
  BOOLEAN                LogIdentifierAppendValueSet;
  ULONG                  LogIdentifierSize;
  CHAR                   LogIdentifier[RECORDER_LOG_IDENTIFIER_MAX_CHARS];
  WPP_RECORDER_TRI_STATE UseTimeStamp;
  WPP_RECORDER_TRI_STATE PreciseTimeStamp;
} RECORDER_LOG_CREATE_PARAMS, *PRECORDER_LOG_CREATE_PARAMS;

メンバー

Size

この構造体のサイズ。

LogTag

ログの割り当てられたメモリに関連付ける省略可能なタグ。

TotalBufferSize

ログ領域のサイズ (バイト単位)。

ErrorPartitionSize

エラー メッセージのログ記録に使用される TotalBufferSize のバイト数。 ゼロはエラー パーティションがないことを示します。

LogIdentifierAppendValue

ログ識別子に追加する数値/ポインター。

LogIdentifierAppendValueSet

LogIdentifierAppendValue が設定されているかどうかを指定します。

LogIdentifierSize

LogIdentifier フィールドのサイズ (クライアントの定義に従ってバイト単位)。

LogIdentifier[RECORDER_LOG_IDENTIFIER_MAX_CHARS]

デバッグ メッセージがマージされるときに出力する識別子。 ある時点でクライアントが配列サイズの定義が異なる場合は、構造体の残りの部分を読み取るのも簡単です。

UseTimeStamp

次を示 すWPP_RECORDER_TRI_STATE型指定された値。

  • WppRecorderTrue に設定すると、ミリ秒単位の粒度のタイムスタンプが WPP ログ エントリに追加されます。
  • WppRecorderFalse に設定すると、タイムスタンプは記録されません。
  • WppRecorderDefault に設定すると、ドライバー パッケージの INF ファイルが WppRecorder_UseTimeStamp を 1 に設定しない限り、WppRecorderDefault と同じ効果を持ちます。その場合は WppRecorderTrue を意味します。

このフィールドは、バージョン 22H2 Windows 11以降で使用できます。 詳細については、「トレース をログに記録するためのインフライト トレース レコーダー (IFR)」を参照してください。

PreciseTimeStamp

次を示 すWPP_RECORDER_TRI_STATE型指定された値。

  • WppRecorderTrue に設定すると、マイクロ秒の粒度の 10 分の 1 のタイムスタンプが WPP ログ エントリに追加されます。
  • WppRecorderFalse に設定すると、タイムスタンプは記録されません。
  • WppRecorderDefault に設定すると、ドライバー パッケージの INF ファイルが WppRecorder_UseTimeStamp に設定され、WppRecorder_PreciseTimeStampが 1 に設定されていない限り、WppRecorderDefault と同じ効果が得られます。その場合は WppRecorderTrue を意味します。

このフィールドは、バージョン 22H2 Windows 11以降で使用できます。 詳細については、「トレース をログに記録するためのインフライト トレース レコーダー (IFR)」を参照してください。

要件

要件 値
Header wpprecorder.h

こちらもご覧ください

RECORDER_LOG_CREATE_PARAMS_INIT