TRACE_EVENT_INFO structure

Defines the information about the event.

Syntax


typedef struct _TRACE_EVENT_INFO {
  GUID                ProviderGuid;
  GUID                EventGuid;
  EVENT_DESCRIPTOR    EventDescriptor;
  DECODING_SOURCE     DecodingSource;
  ULONG               ProviderNameOffset;
  ULONG               LevelNameOffset;
  ULONG               ChannelNameOffset;
  ULONG               KeywordsNameOffset;
  ULONG               TaskNameOffset;
  ULONG               OpcodeNameOffset;
  ULONG               EventMessageOffset;
  ULONG               ProviderMessageOffset;
  ULONG               BinaryXMLOffset;
  ULONG               BinaryXMLSize;
  ULONG               ActivityIDNameOffset;
  ULONG               RelatedActivityIDNameOffset;
  ULONG               PropertyCount;
  ULONG               TopLevelPropertyCount;
  TEMPLATE_FLAGS      Flags;
  EVENT_PROPERTY_INFO EventPropertyInfoArray[ANYSIZE_ARRAY];
  ULONG               Tags;
} TRACE_EVENT_INFO;

Members

ProviderGuid

A GUID that identifies the provider.

EventGuid

A GUID that identifies the MOF class that contains the event. If the provider uses a manifest to define its events, this member is GUID_NULL.

EventDescriptor

A EVENT_DESCRIPTOR structure that describes the event.

DecodingSource

A DECODING_SOURCE enumeration value that identifies the source used to parse the event's data (for example, an instrumenation manifest of WMI MOF class).

ProviderNameOffset

The offset from the beginning of this structure to a null-terminated Unicode string that contains the name of the provider.

LevelNameOffset

The offset from the beginning of this structure to a null-terminated Unicode string that contains the name of the level. For possible names, see Remarks in LevelType.

ChannelNameOffset

The offset from the beginning of this structure to a null-terminated Unicode string that contains the name of the channel. For possible names, see Remarks in ChannelType.

KeywordsNameOffset

The offset from the beginning of this structure to a list of null-terminated Unicode strings that contains the names of the keywords. The list is terminated with two NULL characters. For possible names, see Remarks in KeywordType.

TaskNameOffset

The offset from the beginning of this structure to a null-terminated Unicode string that contains the name of the task. For possible names, see Remarks in TaskType.

OpcodeNameOffset

The offset from the beginning of this structure to a null-terminated Unicode string that contains the name of the operation. For possible names, see Remarks in OpcodeType.

EventMessageOffset

The offset from the beginning of this structure to a null-terminated Unicode string that contains the event message string. The offset is zero if there is no message string. For information on message strings, see the message attribute for EventDefinitionType.

The message string can contain insert sequences, for example, Unable to connect to the %1 printer. The number of the insert sequence identifies the property in the event data to use for the substitution.

ProviderMessageOffset

The offset from the beginning of this structure to a null-terminated Unicode string that contains the localized provider name.

BinaryXMLOffset

Reserved.

BinaryXMLSize

Reserved.

ActivityIDNameOffset

The offset from the beginning of this structure to a null-terminated Unicode string that contains the property name of the activity identifier in the MOF class. Supported for classic ETW events only.

RelatedActivityIDNameOffset

The offset from the beginning of this structure to a null-terminated Unicode string that contains the property name of the related activity identifier in the MOF class. Supported for legacy ETW events only.

PropertyCount

The number of elements in the EventPropertyInfoArray array.

TopLevelPropertyCount

The number of properties in the EventPropertyInfoArray array that are top-level properties. This number does not include members of structures. Top-level properties come before all member properties in the array.

Flags

Reserved.

EventPropertyInfoArray

An array of EVENT_PROPERTY_INFO structures that provides information about each property of the event's user data.

Tags

A 28-bit value associated with the event metadata. This value can be used by the event provider to associate additional semantic data with an event for use by an event processing tool. For example, a tag value of 5 might indicate that the event contains debugging information. The semantics of any values in this field are defined by the event provider.

Remarks

The value of an offset is zero if the member is not defined.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Tdh.h

See also

ChannelType
DECODING_SOURCE
EVENT_DESCRIPTOR
EVENT_PROPERTY_INFO
EventDefinitionType
KeywordType
LevelType
OpcodeType
TaskType
TdhEnumerateManifestProviderEvents
TdhGetEventInformation
TdhGetManifestEventInformation

 

 

Show: