StopTraceW 関数 (evntrace.h)

StopTrace 関数は、指定されたイベント トレース セッションを停止します。

この関数は、現在使用されていません。 ControlTrace 関数は、この関数よりも優先されます。

構文

ULONG WMIAPI StopTraceW(
  CONTROLTRACE_ID         TraceId,
  LPCWSTR                 InstanceName,
  PEVENT_TRACE_PROPERTIES Properties
);

パラメーター

TraceId

InstanceName

停止するイベント トレース セッションの名前( NULL)。 TraceHandle が 0 の場合は、InstanceName を指定する必要があります。

NT カーネル ロガー セッションを指定するには、 InstanceName をKERNEL_LOGGER_NAME に設定します。

Properties

セッションの最終的なプロパティと統計を受け取る EVENT_TRACE_PROPERTIES 構造体へのポインター。

新しく初期化された構造体を使用している場合は、構造体の Wnode.BufferSize、 Wnode.Guid、 LoggerNameOffset、 LogFileNameOffset メンバーのみを設定する必要があります。 最大セッション名 (1024 文字) と最大ログ ファイル名 (1024 文字) を使用して、バッファー サイズとオフセット (不明な場合) を計算できます。

Windows 10 バージョン 1703 以降: プロセス間のシナリオでパフォーマンスを向上させるために、システム全体のプライベート ロガーの StopTrace にフィルター処理を渡すことができます。 フィルター情報を含めるには、新しい EVENT_TRACE_PROPERTIES_V2 構造体を渡す必要があります。 詳細については、「 プライベート ロガー セッションの構成と開始 」を参照してください。

戻り値

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

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

• ERROR_BAD_LENGTH

  次のいずれかが当てはまります。

  • Properties の Wnode.BufferSize メンバーは、正しくないサイズを指定します。
  • セッション 名とログ ファイル名のコピーを保持するための十分な領域がプロパティに割り当てられない (使用されている場合)。

• ERROR_INVALID_PARAMETER

  次のいずれかが当てはまります。

  • プロパティ は NULL です。
  • InstanceName と TraceHandle はどちらも NULL です。
  • InstanceName は NULL で、 TraceHandle は有効なハンドルではありません。

• ERROR_ACCESS_DENIED 管理者特権を持つユーザー、パフォーマンス ログ ユーザー グループ内のユーザー、LocalSystem、LocalService、NetworkService として実行されているサービスのみが、イベント トレース セッションを制御できます。 制限付きユーザーにトレース セッションを制御する機能を付与するには、それらを [パフォーマンス ログ ユーザー] グループに追加します。

  Windows XP と Windows 2000: トレース セッションは誰でも制御できます。

注釈

イベント トレース コントローラーは、この関数を呼び出します。

この関数は、現在使用されていません。 代わりに、ControlCode を EVENT_TRACE_CONTROL_STOP に設定して ControlTrace を使用します。

LogFileMode にEVENT_TRACE_FILE_MODE_PREALLOCATEが含まれている場合、StartTrace はログ ファイルを MaximumFileSize バイトまで拡張します。 ファイルは、循環ログとシーケンシャル ログの両方について、ログ記録中の領域全体を占有します。 ロガーを停止すると、ログ ファイルは必要なサイズに縮小されます。

DllMain から StopTrace を呼び出さないでください (デッドロックが発生する可能性があります)。

要件

こちらもご覧ください

ControlTrace

StartTrace