LoggingFields Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a sequence of event fields and provides methods for adding fields to the sequence.
public ref class LoggingFields sealed/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class LoggingFields final/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class LoggingFields final[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class LoggingFields[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class LoggingFieldsfunction LoggingFields()Public NotInheritable Class LoggingFields- Inheritance
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
Remarks
You can pass this object to a LoggingChannel.LogEvent method to provide the payload (data) for an event.
This class is not thread-safe. Ensure that an instance of this class is not modified simultaneously by multiple threads.
This class can create nested structures. To create a structure, call BeginStruct to mark the start of the structure. Then add the fields that are part of the structure. Finally, call EndStruct to mark the end of the structure. Structures can be nested up to eight levels deep.
Tip
Field names and field tags should be used for infrequently-changing metadata, not for frequently-changing data. The values for field names and tags should generally be constants, not variables. Event names, event tags, field names, field tags, and field formats are part of an event’s identity, and each unique event identity is tracked by a LoggingChannel. Using frequently-changing values for field names and tags will lead to increased memory usage in your application, and may make event decoding or analysis more complex.
Constructors
| LoggingFields() |
Initializes a new LoggingFields instance. |
Methods
| AddBoolean(String, Boolean) |
Adds a boolean field with the specified field name. |
| AddBoolean(String, Boolean, LoggingFieldFormat) |
Adds a boolean field with the specified field name and format. |
| AddBoolean(String, Boolean, LoggingFieldFormat, Int32) |
Adds a boolean field with the specified field name, format, and tags. |
| AddBooleanArray(String, Boolean[]) |
Adds a boolean array field with the specified field name. |
| AddBooleanArray(String, Boolean[], LoggingFieldFormat) |
Adds a boolean array field with the specified field name and format. |
| AddBooleanArray(String, Boolean[], LoggingFieldFormat, Int32) |
Adds a boolean array field with the specified field name, format, and tag. |
| AddChar16(String, Char) |
Adds a 16-bit character field with the specified field name. |
| AddChar16(String, Char, LoggingFieldFormat) |
Adds a 16-bit character field with the specified field name and format. |
| AddChar16(String, Char, LoggingFieldFormat, Int32) |
Adds a 16-bit character field with the specified field name, format, and tag. |
| AddChar16Array(String, Char[]) |
Adds a 16-bit character array field with the specified field name. |
| AddChar16Array(String, Char[], LoggingFieldFormat) |
Adds a 16-bit character array field with the specified field name and format. |
| AddChar16Array(String, Char[], LoggingFieldFormat, Int32) |
Adds a 16-bit character array field with the specified field name and format, and tags. |
| AddDateTime(String, DateTime) |
Adds a DateTime field with the specified field name. |
| AddDateTime(String, DateTime, LoggingFieldFormat) |
Adds a DateTime field with the specified field name and format. |
| AddDateTime(String, DateTime, LoggingFieldFormat, Int32) |
Adds a DateTime field with the specified field name, format, and tags. |
| AddDateTimeArray(String, DateTime[]) |
Adds a DateTime array field with the specified field name. |
| AddDateTimeArray(String, DateTime[], LoggingFieldFormat) |
Adds a DateTime array field with the specified field name and format. |
| AddDateTimeArray(String, DateTime[], LoggingFieldFormat, Int32) |
Adds a DateTime array field with the specified field name, format, and tags. |
| AddDouble(String, Double) |
Adds a Double field with the specified field name. |
| AddDouble(String, Double, LoggingFieldFormat) |
Adds a Double field with the specified field name and format. |
| AddDouble(String, Double, LoggingFieldFormat, Int32) |
Adds a Double field with the specified field name, format, and tags. |
| AddDoubleArray(String, Double[]) |
Adds a Double array field with the specified field name. |
| AddDoubleArray(String, Double[], LoggingFieldFormat) |
Adds a Double array field with the specified field name and format. |
| AddDoubleArray(String, Double[], LoggingFieldFormat, Int32) |
Adds a Double array field with the specified field name, format, and tags. |
| AddEmpty(String) |
Adds an empty field. |
| AddEmpty(String, LoggingFieldFormat) |
Adds an empty field. |
| AddEmpty(String, LoggingFieldFormat, Int32) |
Adds an empty field. |
| AddGuid(String, Guid) |
Adds a GUID field with the specified field name. |
| AddGuid(String, Guid, LoggingFieldFormat) |
Adds a GUID field with the specified field name and format. |
| AddGuid(String, Guid, LoggingFieldFormat, Int32) |
Adds a GUID field with the specified field name, format, and tags. |
| AddGuidArray(String, Guid[]) |
Adds a GUID array field with the specified field name. |
| AddGuidArray(String, Guid[], LoggingFieldFormat) |
Adds a GUID array field with the specified field name and format |
| AddGuidArray(String, Guid[], LoggingFieldFormat, Int32) |
Adds a GUID array field with the specified field name, format, and tags. |
| AddInt16(String, Int16) |
Adds a 16-bit integer field with the specified field name. |
| AddInt16(String, Int16, LoggingFieldFormat) |
Adds a 16-bit integer field with the specified field name and format. |
| AddInt16(String, Int16, LoggingFieldFormat, Int32) |
Adds a 16-bit integer field with the specified field name, format, and tags. |
| AddInt16Array(String, Int16[]) |
Adds a 16-bit integer array field with the specified field name. |
| AddInt16Array(String, Int16[], LoggingFieldFormat) |
Adds a 16-bit integer array field with the specified field name and format. |
| AddInt16Array(String, Int16[], LoggingFieldFormat, Int32) |
Adds a 16-bit integer array field with the specified field name, format, and tags. |
| AddInt32(String, Int32) |
Adds a 32-bit integer array field with the specified field name. |
| AddInt32(String, Int32, LoggingFieldFormat) |
Adds a 32-bit integer array field with the specified field name and format. |
| AddInt32(String, Int32, LoggingFieldFormat, Int32) |
Adds a 32-bit integer array field with the specified field name, format, and tags. |
| AddInt32Array(String, Int32[]) |
Adds a 32-bit integer array field with the specified field name. |
| AddInt32Array(String, Int32[], LoggingFieldFormat) |
Adds a 32-bit integer array field with the specified field name and format. |
| AddInt32Array(String, Int32[], LoggingFieldFormat, Int32) |
Adds a 32-bit integer array field with the specified field name, format, and tags. |
| AddInt64(String, Int64) |
Adds a 64-bit integer array field with the specified field name. |
| AddInt64(String, Int64, LoggingFieldFormat) |
Adds a 64-bit integer array field with the specified field name and format. |
| AddInt64(String, Int64, LoggingFieldFormat, Int32) |
Adds a 64-bit integer field with the specified field name, format, and tags. |
| AddInt64Array(String, Int64[]) |
Adds a 64-bit integer array field with the specified field name. |
| AddInt64Array(String, Int64[], LoggingFieldFormat) |
Adds a 64-bit integer array field with the specified field name and format. |
| AddInt64Array(String, Int64[], LoggingFieldFormat, Int32) |
Adds a 64-bit integer array field with the specified field name, format, and tags. |
| AddPoint(String, Point) |
Adds a Point field with the specified name. |
| AddPoint(String, Point, LoggingFieldFormat) |
Adds a Point field with the specified name and format. |
| AddPoint(String, Point, LoggingFieldFormat, Int32) |
Adds a Point field with the specified name, format, and tags. |
| AddPointArray(String, Point[]) |
Adds a Point array field with the specified field name. |
| AddPointArray(String, Point[], LoggingFieldFormat) |
Adds a Point array field with the specified field name and format. |
| AddPointArray(String, Point[], LoggingFieldFormat, Int32) |
Adds a Point array field with the specified field name, format, and tags. |
| AddRect(String, Rect) |
Adds a Rect field with the specified field name. |
| AddRect(String, Rect, LoggingFieldFormat) |
Adds a Rect field with the specified field name, and format. |
| AddRect(String, Rect, LoggingFieldFormat, Int32) |
Adds a Rect field with the specified field name, format, and tags. |
| AddRectArray(String, Rect[]) |
Adds a Rect array field with the specified field name. |
| AddRectArray(String, Rect[], LoggingFieldFormat) |
Adds a Rect array field with the specified field name and format. |
| AddRectArray(String, Rect[], LoggingFieldFormat, Int32) |
Adds a Rect array field with the specified field name, format, and tags. |
| AddSingle(String, Single) |
Adds a Single field with the specified field name. |
| AddSingle(String, Single, LoggingFieldFormat) |
Adds a Single field with the specified field name and format. |
| AddSingle(String, Single, LoggingFieldFormat, Int32) |
Adds a Single field with the specified field name, format, and tags. |
| AddSingleArray(String, Single[]) |
Adds a Single array field with the specified field name. |
| AddSingleArray(String, Single[], LoggingFieldFormat) |
Adds a Single array field with the specified field name and format. |
| AddSingleArray(String, Single[], LoggingFieldFormat, Int32) |
Adds a Single array field with the specified field name, format, and tags. |
| AddSize(String, Size) |
Adds a Size field with the specified field name. |
| AddSize(String, Size, LoggingFieldFormat) |
Adds a Size field with the specified field name and format. |
| AddSize(String, Size, LoggingFieldFormat, Int32) |
Adds a Size field with the specified field name, format, and tags. |
| AddSizeArray(String, Size[]) |
Adds a Size array field with the specified field name. |
| AddSizeArray(String, Size[], LoggingFieldFormat) |
Adds a Size array field with the specified field name and format. |
| AddSizeArray(String, Size[], LoggingFieldFormat, Int32) |
Adds a Size array field with the specified field name, format, and tags. |
| AddString(String, String) |
Adds a String field with the specified field name. |
| AddString(String, String, LoggingFieldFormat) |
Adds a String field with the specified field name and format. |
| AddString(String, String, LoggingFieldFormat, Int32) |
Adds a String field with the specified field name, format, and tags. |
| AddStringArray(String, String[]) |
Adds a String array field with the specified field name. |
| AddStringArray(String, String[], LoggingFieldFormat) |
Adds a String array field with the specified field name and format. |
| AddStringArray(String, String[], LoggingFieldFormat, Int32) |
Adds a String array field with the specified field name, format, and tags. |
| AddTimeSpan(String, TimeSpan) |
Adds a time span field with the specified field name. |
| AddTimeSpan(String, TimeSpan, LoggingFieldFormat) |
Adds a time span field with the specified field name and format. |
| AddTimeSpan(String, TimeSpan, LoggingFieldFormat, Int32) |
Adds a time span field with the specified field name, format, and tags. |
| AddTimeSpanArray(String, TimeSpan[]) |
Adds a time span array field with the specified field name. |
| AddTimeSpanArray(String, TimeSpan[], LoggingFieldFormat) |
Adds a time span array field with the specified field name and format. |
| AddTimeSpanArray(String, TimeSpan[], LoggingFieldFormat, Int32) |
Adds a time span array field with the specified field name, format, and tags. |
| AddUInt16(String, UInt16) |
Adds a 16-bit unsigned integer field with the specified field name. |
| AddUInt16(String, UInt16, LoggingFieldFormat) |
Adds a 16-bit unsigned integer field with the specified field name and format. |
| AddUInt16(String, UInt16, LoggingFieldFormat, Int32) |
Adds a 16-bit unsigned integer field with the specified field name, format, and tags. |
| AddUInt16Array(String, UInt16[]) |
Adds a16-bit unsigned integer field with the specified field name. |
| AddUInt16Array(String, UInt16[], LoggingFieldFormat) |
Adds a 16-bit unsigned integer array field with the specified field name and format. |
| AddUInt16Array(String, UInt16[], LoggingFieldFormat, Int32) |
Adds a 16-bit unsigned integer array field with the specified field name, format, and tags. |
| AddUInt32(String, UInt32) |
Adds a 32-bit unsigned integer field with the specified field name. |
| AddUInt32(String, UInt32, LoggingFieldFormat) |
Adds a 32-bit unsigned integer field with the specified field name and format. |
| AddUInt32(String, UInt32, LoggingFieldFormat, Int32) |
Adds a 32-bit unsigned integer field with the specified field name, format, and tags. |
| AddUInt32Array(String, UInt32[]) |
Adds a 32-bit unsigned integer array field with the specified field name. |
| AddUInt32Array(String, UInt32[], LoggingFieldFormat) |
Adds a 32-bit unsigned integer array field with the specified field name and format. |
| AddUInt32Array(String, UInt32[], LoggingFieldFormat, Int32) |
Adds a 32-bit unsigned integer array field with the specified field name, format, and tags. |
| AddUInt64(String, UInt64) |
Adds a 64-bit unsigned integer field with the specified field name. |
| AddUInt64(String, UInt64, LoggingFieldFormat) |
Adds a 64-bit unsigned integer field with the specified field name and format. |
| AddUInt64(String, UInt64, LoggingFieldFormat, Int32) |
Adds a 64-bit unsigned integer field with the specified field name, format, and tags. |
| AddUInt64Array(String, UInt64[]) |
Adds a 64-bit unsigned integer array field with the specified field name. |
| AddUInt64Array(String, UInt64[], LoggingFieldFormat) |
Adds a 64-bit unsigned integer array field with the specified field name and format. |
| AddUInt64Array(String, UInt64[], LoggingFieldFormat, Int32) |
Adds a 64-bit unsigned integer array field with the specified field name, format, and tags. |
| AddUInt8(String, Byte) |
Adds an 8-bit unsigned integer field with the specified field name. |
| AddUInt8(String, Byte, LoggingFieldFormat) |
Adds an 8-bit unsigned integer field with the specified field name and format. |
| AddUInt8(String, Byte, LoggingFieldFormat, Int32) |
Adds an 8-bit unsigned integer field with the specified field name, format, and tags. |
| AddUInt8Array(String, Byte[]) |
Adds an 8-bit unsigned integer array field with the specified field name. |
| AddUInt8Array(String, Byte[], LoggingFieldFormat) |
Adds an 8-bit unsigned integer array field with the specified field name and format. |
| AddUInt8Array(String, Byte[], LoggingFieldFormat, Int32) |
Adds an 8-bit unsigned integer array field with the specified field name, format, and tags. |
| BeginStruct(String) |
Begins a new structured field with the specified field name. |
| BeginStruct(String, Int32) |
Begins a new structured field with the specified field name and tags. |
| Clear() |
Removes all fields stored in the object and resets the object to its newly-constructed state. |
| EndStruct() |
Ends a structured field. |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for