LoggingFieldFormat LoggingFieldFormat LoggingFieldFormat LoggingFieldFormat Enum

Definition

public : enum class LoggingFieldFormatpublic enum LoggingFieldFormatPublic Enum LoggingFieldFormat// You can use this enum in JavaScript.

Attributes

ContractVersionAttribute

Device family	Windows 10 (introduced v10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v1)

Fields

Boolean Boolean Boolean Boolean	A boolean field.
Default Default Default Default	No format is specified.
FileTime FileTime FileTime FileTime	A 64-bit FILETIME value.
Hexadecimal Hexadecimal Hexadecimal Hexadecimal	A hexadecimal field.
Hidden Hidden Hidden Hidden	The field is hidden.
HResult HResult HResult HResult	A 32-bit Windows HRESULT value.
Ipv4Address Ipv4Address Ipv4Address Ipv4Address	An Internet Protocol version 4 (IPv4) field.
Ipv6Address Ipv6Address Ipv6Address Ipv6Address	An Internet Protocol version 6 (IPv6) field.
Json Json Json Json	A JavaScript Object Notation (JSON) field.
NTStatus NTStatus NTStatus NTStatus	A 32-bit Windows NTSTATUS value.
Port Port Port Port	A port number field.
ProcessId ProcessId ProcessId ProcessId	A process identifier field.
Signed Signed Signed Signed	A signed value.
SocketAddress SocketAddress SocketAddress SocketAddress	A socket address field.
String String String String	The field contains a MBCS (8-bit character) string.
ThreadId ThreadId ThreadId ThreadId	A thread identifier field.
Unsigned Unsigned Unsigned Unsigned	An unsigned value.
Win32Error Win32Error Win32Error Win32Error	A 32-bit Win32 error code.
Xml Xml Xml Xml	An Extensible Markup Language (XML) field.

Remarks

When an Event Tracing for Windows (ETW) payload is decoded by an event processing tool such as xperf or Windows Performance Analyzer (WPA), the tool may make use of formatting hints to interpret the field. Formatting hints are optional parameters to LoggingFields.Add.

For example, an int32 field may specify the Hexadecimal ** format to indicate that it should be displayed in unsigned-hexadecimal. A byte-array field may specify the **Signed format to indicate that it should be treated as a series of signed decimal integers, or it may specify the String format to indicate that it should be treated as an MBCS (8-bit character) string.