QueryTraceA 関数 (evntrace.h)
QueryTrace 関数は、指定されたイベント トレース セッションのプロパティ設定とセッション統計を取得します。
この関数は、現在使用されていません。 ControlTrace 関数は、この関数よりも優先されます。
構文
ULONG WMIAPI QueryTraceA(
CONTROLTRACE_ID TraceId,
LPCSTR InstanceName,
PEVENT_TRACE_PROPERTIES Properties
);
パラメーター
TraceId
InstanceName
クエリを実行するイベント トレース セッションの名前( NULL)。 TraceHandle が 0 の場合は、InstanceName を指定する必要があります。
NT カーネル ロガー セッションを指定するには、 InstanceName をKERNEL_LOGGER_NAME に設定します。
Properties
初期化された EVENT_TRACE_PROPERTIES 構造体へのポインター。
EVENT_TRACE_PROPERTIES構造体の Wnode.BufferSize メンバーのみを設定する必要があります。 最大セッション名 (1024 文字) と最大ログ ファイル名 (1024 文字) を使用して、バッファー サイズとオフセット (不明な場合) を計算できます。
出力時に、構造体メンバーには、イベント トレース セッションのプロパティ設定とセッション統計が含まれます。
Windows 10 バージョン 1703 以降: プロセス間のシナリオでパフォーマンスを向上させるために、システム全体のプライベート ロガーの QueryTrace にフィルター処理を渡すようになりました。 フィルター情報を含めるには、新しい 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 として実行されているサービスのみが、イベント トレース セッションに対してクエリを実行できます。 制限付きユーザーにトレース セッションのクエリ機能を付与するには、それらをパフォーマンス ログ ユーザー グループに追加するか、「 EventAccessControl」を参照してください。
Windows XP と Windows 2000: トレース セッションは誰でも制御できます。
ERROR_WMI_INSTANCE_NOT_FOUND
指定されたセッションが実行されていません。
注釈
イベント トレース コントローラーは、この関数を呼び出します。
この関数は、現在使用されていません。 代わりに、 ControlCode を EVENT_TRACE_CONTROL_QUERY に設定して ControlTrace を使用 します。
注意
evntrace.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして QueryTrace を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリ |UWP アプリ] |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリ |UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | evntrace.h |
Library | Advapi32.lib |
[DLL] | Advapi32.dll |