イベント クラス

  • [アーティクル]

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

Event クラスは、MatchEvent、MatchEventInMemberFunction、MatchEventStack、および MatchEventStackInMemberFunction 関数と共に使用されます。 任意のイベントと照合するために使用します。

構文

class Event
{
public:
    Event(const RawEvent& event);

    const unsigned short&        EventId() const;
    const unsigned long long&    EventInstanceId() const;
    const long long&             TickFrequency() const;
    const long long&             Timestamp() const;
    const unsigned long&         ProcessId() const;
    const unsigned long&         ThreadId() const;
    const unsigned short&        ProcessorIndex() const;
    const char*                  EventName() const;
    const wchar_t*               EventWideName() const;
};

メンバー

コンストラクター

Event

機能

DataEventId
EventInstanceId
EventName
EventWideName
ProcessId
ProcessorIndex
ThreadId
TickFrequency
Timestamp

Event

Event(const RawEvent& event);

パラメーター

event
任意のイベント。

データ

const void* Data() const;

戻り値

このイベントに含まれる追加データへのポインター。 このフィールドを解釈する方法の詳細については、EVENT_DATA に関する記事を参照してください。

EventId

const unsigned short& EventId() const;

戻り値

イベントの種類を識別する番号。 イベント識別子の一覧については、EVENT_ID に関する記事をご覧ください。

EventInstanceId

const unsigned long long& EventInstanceId() const;

戻り値

トレース内のイベントを一意に識別する番号。 この値は、同じトレースを複数回分析またはログに再記録しても変わりません。 この値を使用して、同じトレースに対する複数の分析パスまたは再ログ記録パスで同じイベントを識別します。

EventName

const char* EventName() const;

戻り値

EventId によって示されるイベントの種類の名前が含まれる ANSI 文字列。

EventWideName

const wchar_t* EventWideName() const;

戻り値

EventId によって示されるイベントの名前が含まれるワイド文字列。

ProcessId

const unsigned long& ProcessId() const;

戻り値

イベントが発生したプロセスの識別子。

ProcessorIndex

const unsigned short& ProcessorIndex() const;

戻り値

イベントが発生した論理プロセッサに対する 0 から始まるインデックス。

スレッド Id

const unsigned long& ThreadId() const;

戻り値

イベントが発生したスレッドの識別子。

TickFrequency

const long long& TickFrequency() const;

戻り値

このイベントのティック単位で計測された期間を評価するときに使用する、1 秒あたりのティック数。

Timestamp

const long long& Timestamp() const;

戻り値

イベントがアクティビティである場合、この関数からは、アクティビティの開始時にキャプチャされたティック値が返されます。 簡易イベントの場合は、この関数からは、イベントが発生したときにキャプチャされたティック値が返されます。