LoggingFieldFormat Enum

Definition

Namespace:

Windows.Foundation.Diagnostics

Specifies the format of an event field.

public enum class LoggingFieldFormat

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class LoggingFieldFormat

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum LoggingFieldFormat

var value = Windows.Foundation.Diagnostics.LoggingFieldFormat.default

Public Enum LoggingFieldFormat

Inheritance

Enum

LoggingFieldFormat

Attributes

ContractVersionAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Fields

Boolean	3	A boolean field.
Default	0	No format is specified.
FileTime	16	A 64-bit FILETIME value.
Hexadecimal	4	A hexadecimal field.
Hidden	1	The field is hidden.
HResult	15	A 32-bit Windows HRESULT value.
Ipv4Address	8	An Internet Protocol version 4 (IPv4) field.
Ipv6Address	9	An Internet Protocol version 6 (IPv6) field.
Json	12	A JavaScript Object Notation (JSON) field.
NTStatus	14	A 32-bit Windows NTSTATUS value.
Port	7	A port number field.
ProcessId	5	A process identifier field.
Signed	17	A signed value.
SocketAddress	10	A socket address field.
String	2	The field contains a MBCS (8-bit character) string.
ThreadId	6	A thread identifier field.
Unsigned	18	An unsigned value.
Win32Error	13	A 32-bit Win32 error code.
Xml	11	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.