EVENT_PROPERTY_INFO structure

Provides information about a single property of the event or filter.

Syntax


typedef struct _EVENT_PROPERTY_INFO {
  PROPERTY_FLAGS Flags;
  ULONG          NameOffset;
  union {
    struct {
      USHORT InType;
      USHORT OutType;
      ULONG  MapNameOffset;
    } nonStructType;
    struct {
      USHORT StructStartIndex;
      USHORT NumOfStructMembers;
      ULONG  padding;
    } structType;
  };
  union {
    USHORT count;
    USHORT countPropertyIndex;
  };
  union {
    USHORT length;
    USHORT lengthPropertyIndex;
  };
  ULONG          Reserved;
} EVENT_PROPERTY_INFO;

Members

Flags

Flags that indicate if the property is contained in a structure or array. For possible values, see the PROPERTY_FLAGS enumeration.

NameOffset

Offset to a null-terminated Unicode string that contains the name of the property. If this an event property, the offset is from the beginning of the TRACE_EVENT_INFO structure. If this is a filter property, the offset is from the beginning of the PROVIDER_FILTER_INFO structure.

nonStructType

Use these members if the PropertyStruct flag in Flags is not set; otherwise, use the structType member.

InType

Data type of this property on input. For a description of these types, see Remarks in InputType.

TDH_INTYPE_NULL (not used)
TDH_INTYPE_UNICODESTRING
TDH_INTYPE_ANSISTRING
TDH_INTYPE_INT8
TDH_INTYPE_UINT8
TDH_INTYPE_INT16
TDH_INTYPE_UINT16
TDH_INTYPE_INT32
TDH_INTYPE_UINT32
TDH_INTYPE_INT64
TDH_INTYPE_UINT64
TDH_INTYPE_FLOAT
TDH_INTYPE_DOUBLE
TDH_INTYPE_BOOLEAN
TDH_INTYPE_BINARY
TDH_INTYPE_GUID
TDH_INTYPE_POINTER
TDH_INTYPE_FILETIME
TDH_INTYPE_SYSTEMTIME
TDH_INTYPE_SID
TDH_INTYPE_HEXINT32
TDH_INTYPE_HEXINT64

For descriptions of these types, see Event Tracing MOF Qualifiers.

TDH_INTYPE_COUNTEDSTRING (see the StringTermination qualifier)
TDH_INTYPE_COUNTEDANSISTRING
TDH_INTYPE_REVERSEDCOUNTEDSTRING
TDH_INTYPE_REVERSEDCOUNTEDANSISTRING
TDH_INTYPE_NONNULLTERMINATEDSTRING (call TdhGetPropertySize to get the length of the string in bytes)
TDH_INTYPE_NONNULLTERMINATEDANSISTRING (call TdhGetPropertySize to get the length of the string in bytes)
TDH_INTYPE_UNICODECHAR (is a char16 WMI data type)
TDH_INTYPE_ANSICHAR (see the Format qualifier type, c)
TDH_INTYPE_SIZET (see the Extension qualifier value, SizeT)
TDH_INTYPE_HEXDUMP (see the Extension qualifier value, Variant)
TDH_INTYPE_WBEMSID (see the Extension qualifier value, Sid)
OutType

Output format for this property. If the value is TDH_OUTTYPE_NULL, use the in type as the output format. For a description of these types, see Remarks in InputType.

TDH_OUTTYPE_NULL
TDH_OUTTYPE_STRING
TDH_OUTTYPE_DATETIME
TDH_OUTTYPE_BYTE
TDH_OUTTYPE_UNSIGNEDBYTE
TDH_OUTTYPE_SHORT
TDH_OUTTYPE_UNSIGNEDSHORT
TDH_OUTTYPE_INT
TDH_OUTTYPE_UNSIGNEDINT
TDH_OUTTYPE_LONG
TDH_OUTTYPE_UNSIGNEDLONG
TDH_OUTTYPE_FLOAT
TDH_OUTTYPE_DOUBLE
TDH_OUTTYPE_BOOLEAN
TDH_OUTTYPE_GUID
TDH_OUTTYPE_HEXBINARY
TDH_OUTTYPE_HEXINT8
TDH_OUTTYPE_HEXINT16
TDH_OUTTYPE_HEXINT32
TDH_OUTTYPE_HEXINT64
TDH_OUTTYPE_PID
TDH_OUTTYPE_TID
TDH_OUTTYPE_PORT
TDH_OUTTYPE_IPV4
TDH_OUTTYPE_IPV6
TDH_OUTTYPE_SOCKETADDRESS
TDH_OUTTYPE_CIMDATETIME (not supported)
TDH_OUTTYPE_ETWTIME
TDH_OUTTYPE_XML
TDH_OUTTYPE_ERRORCODE
TDH_OUTTYPE_WIN32ERROR
TDH_OUTTYPE_NTSTATUS
TDH_OUTTYPE_HRESULT
TDH_OUTTYPE_CULTURE_INSENSITIVE_DATETIME

For descriptions of these types, see Event Tracing MOF Qualifiers.

TDH_OUTTYPE_REDUCEDSTRING (see the Extension qualifier values, RString and RWString)
TDH_OUTTYPE_NOPRINT (see the Extension qualifier value, NoPrint)
MapNameOffset

Offset from the beginning of the TRACE_EVENT_INFO structure to a null-terminated Unicode string that contains the name of the map attribute value. You can pass this string to TdhGetEventMapInformation to retrieve information about the value map.

structType

Use these members if the PropertyStruct flag in Flags is set; otherwise, use the nonStructType member.

StructStartIndex

Zero-based index to the element of the property array that contains the first member of the structure.

NumOfStructMembers

Number of members in the structure.

padding

Not used.

count

Number of elements in the array. Note that this value is 1 for properties that are not defined as an array.

countPropertyIndex

Zero-based index to the element of the property array that contains the number of elements in the array. Use this member if the PropertyParamCount flag in Flags is set; otherwise, use the count member.

length

Size of the property, in bytes. Note that variable-sized types such as strings and binary data have a length of zero unless the property has length attribute to explicitly indicate its real length. Structures have a length of zero.

lengthPropertyIndex

Zero-based index to the element of the property array that contains the size value of this property. Use this member if the PropertyParamLength flag in Flags is set; otherwise, use the length member.

Reserved

Reserved.

Remarks

Filters do not support maps, structures, or arrays.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Tdh.h

See also

PROVIDER_FILTER_INFO
TRACE_EVENT_INFO

 

 

Community Additions

ADD
Show:
© 2015 Microsoft