IRelogger クラス

[アーティクル]
07/19/2022

C++ Build Insights SDK は、Visual Studio 2017 以降と互換性があります。これらのバージョンのドキュメントを表示するには、この記事の Visual Studio バージョン セレクターコントロールを Visual Studio 2017 以降に設定します。このページの目次の一番上にあります。

IRelogger クラスにより、Event Tracing for Windows (ETW) トレースの再ログ記録を行うためのインターフェイスが提供されます。 MakeDynamicReloggerGroup 関数と MakeStaticReloggerGroup 関数で使用されます。リロガーグループの一部にできる独自のリロガーを作成するための基底クラスとしては、IRelogger を使用します。

構文

class IRelogger
{
public:
    virtual AnalysisControl OnStartActivity(const EventStack& eventStack,
        const void* relogSession);

    virtual AnalysisControl OnStopActivity(const EventStack& eventStack,
        const void* relogSession);

    virtual AnalysisControl OnSimpleEvent(const EventStack& eventStack,
        const void* relogSession);

    virtual AnalysisControl OnTraceInfo(const TraceInfo& traceInfo);
    virtual AnalysisControl OnBeginRelogging();
    virtual AnalysisControl OnEndRelogging();
    virtual AnalysisControl OnBeginReloggingPass();
    virtual AnalysisControl OnEndReloggingPass() ;

    virtual ~IRelogger();
};

解説

オーバーライドされていないすべての関数の既定の戻り値は AnalysisControl::CONTINUE です。詳細については、AnalysisControl に関する記事をご覧ください。

メンバー

デストラクターです。

~IRelogger

機能

OnBeginRelogging
OnBeginReloggingPass
OnEndRelogging
OnEndReloggingPass
OnSimpleEvent
OnStartActivity
OnStopActivity
OnTraceInfo

~IRelogger

IRelogger クラスを破棄します。

virtual ~IRelogger();

OnBeginRelogging

この関数は、再ログ記録パスが開始される前に呼び出されます。

virtual AnalysisControl OnBeginRelogging();

戻り値

次に行う必要があることが記述されている AnalysisControl コード。

OnBeginReloggingPass

この関数は、再ログ記録パスの開始時に呼び出されます。

virtual AnalysisControl OnBeginReloggingPass();

戻り値

次に行う必要があることが記述されている AnalysisControl コード。

OnEndRelogging

この関数は、再ログ記録パスが終了した後で呼び出されます。

virtual AnalysisControl OnEndRelogging();

戻り値

次に行う必要があることが記述されている AnalysisControl コード。

OnEndReloggingPass

この関数は、再ログ記録パスの終了時に呼び出されます。

virtual AnalysisControl OnEndReloggingPass();

戻り値

次に行う必要があることが記述されている AnalysisControl コード。

OnSimpleEvent

virtual AnalysisControl OnSimpleEvent(const EventStack& eventStack);

この関数は、簡易イベントが処理されるときに呼び出されます。

パラメーター

eventStack
この簡易イベントのイベントスタック。イベントスタックの詳細については、イベントに関するページを参照してください。

戻り値

次に行う必要があることが記述されている AnalysisControl コード。

OnStartActivity

virtual AnalysisControl OnStartActivity(const EventStack& eventStack);

この関数は、アクティビティ開始イベントが処理されるときに呼び出されます。

パラメーター

eventStack
このアクティビティ開始イベントのイベントスタック。イベントスタックの詳細については、イベントに関するページを参照してください。

戻り値

次に行う必要があることが記述されている AnalysisControl コード。

OnStopActivity

この関数は、アクティビティ停止イベントが処理されるときに呼び出されます。

virtual AnalysisControl OnStopActivity(const EventStack& eventStack);

パラメーター

eventStack
このアクティビティ停止イベントのイベントスタック。イベントスタックの詳細については、イベントに関するページを参照してください。

戻り値

次に行う必要があることが記述されている AnalysisControl コード。

OnTraceInfo

virtual AnalysisControl OnTraceInfo(const TraceInfo& traceInfo);

この関数は、すべての分析パスまたは再ログ記録パスの開始時に 1 回呼び出されます。

パラメーター

traceInfo
使用されているトレースに関する有用なプロパティが格納される TraceInfo オブジェクト。

戻り値

次に行う必要があることが記述されている AnalysisControl コード。