LoggingFields.AddUInt8Array Method

Definition

Namespace:

Windows.Foundation.Diagnostics

Overloads

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.

AddUInt8Array(String, Byte[])

Adds an 8-bit unsigned integer array field with the specified field name.

public:
 virtual void AddUInt8Array(Platform::String ^ name, Platform::Array <byte> ^ value) = AddUInt8Array;

/// [Windows.Foundation.Metadata.Overload("AddUInt8Array")]
void AddUInt8Array(winrt::hstring const& name, winrt::array_view <byte> const& value);

[Windows.Foundation.Metadata.Overload("AddUInt8Array")]
public void AddUInt8Array(string name, byte[] value);

function addUInt8Array(name, value)

Public Sub AddUInt8Array (name As String, value As Byte())

Parameters

name

String

Platform::String

winrt::hstring

Name of the event field.

value

Byte[]

byte[]

The value for the event field. The format for the array is binary.

Attributes

OverloadAttribute

See also

• AddUInt8Array(String, Byte[], LoggingFieldFormat)
• AddUInt8Array(String, Byte[], LoggingFieldFormat, Int32)

AddUInt8Array(String, Byte[], LoggingFieldFormat)

Adds an 8-bit unsigned integer array field with the specified field name and format.

public:
 virtual void AddUInt8Array(Platform::String ^ name, Platform::Array <byte> ^ value, LoggingFieldFormat format) = AddUInt8Array;

/// [Windows.Foundation.Metadata.Overload("AddUInt8ArrayWithFormat")]
void AddUInt8Array(winrt::hstring const& name, winrt::array_view <byte> const& value, LoggingFieldFormat const& format);

[Windows.Foundation.Metadata.Overload("AddUInt8ArrayWithFormat")]
public void AddUInt8Array(string name, byte[] value, LoggingFieldFormat format);

function addUInt8Array(name, value, format)

Public Sub AddUInt8Array (name As String, value As Byte(), format As LoggingFieldFormat)

Parameters

name

String

Platform::String

winrt::hstring

Name of the event field.

value

Byte[]

byte[]

The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified.

format

LoggingFieldFormat

The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Attributes

OverloadAttribute

Remarks

Use the format parameter to specify the format of the array. You may use the following LoggingFieldFormat formats:

Value	Description
Default	No format is specified.
Boolean	Data is treated as an array of boolean values
Hexadecimal	Data is treated as an array of 8-bit integers, formatted as hexadecimal
Ipv6Address	Data is treated as an IPv6 address
Json	Data is treated as a Multi-Byte Character Set (MBCS) JavaScript Object Notation (JSON) string
Signed	Data is treated as an array of signed 8-bit integers
String	Data is treated as a MBCS string
SocketAddress	Data is treated as a sockaddr
Unsigned	Data is treated as an array of unsigned 8-bit integers
XML	Data is treated as an MBCS XML string

See also

• AddUInt8Array(String, Byte[])
• AddUInt8Array(String, Byte[], LoggingFieldFormat, Int32)

AddUInt8Array(String, Byte[], LoggingFieldFormat, Int32)

Adds an 8-bit unsigned integer array field with the specified field name, format, and tags.

public:
 virtual void AddUInt8Array(Platform::String ^ name, Platform::Array <byte> ^ value, LoggingFieldFormat format, int tags) = AddUInt8Array;

/// [Windows.Foundation.Metadata.Overload("AddUInt8ArrayWithFormatAndTags")]
void AddUInt8Array(winrt::hstring const& name, winrt::array_view <byte> const& value, LoggingFieldFormat const& format, int const& tags);

[Windows.Foundation.Metadata.Overload("AddUInt8ArrayWithFormatAndTags")]
public void AddUInt8Array(string name, byte[] value, LoggingFieldFormat format, int tags);

function addUInt8Array(name, value, format, tags)

Public Sub AddUInt8Array (name As String, value As Byte(), format As LoggingFieldFormat, tags As Integer)

Parameters

name

String

Platform::String

winrt::hstring

Name of the event field.

value

Byte[]

byte[]

The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified.

format

LoggingFieldFormat

The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

tags

Int32

int

The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Attributes

OverloadAttribute

Remarks

Use the format parameter to specify the format of the array. You may use the following LoggingFieldFormat formats:

Default	No format is specified.
Boolean	Data is treated as an array of boolean values
Hexadecimal	Data is treated as an array of 8-bit integers, formatted as hexadecimal
Ipv6Address	Data is treated as an IPv6 address
Json	Data is treated as a Multi-Byte Character Set (MBCS) JavaScript Object Notation (JSON) string
Signed	Data is treated as an array of signed 8-bit integers
String	Data is treated as a MBCS string
SocketAddress	Data is treated as a [sockaddr](/windows/desktop/WinSock/sockaddr-2)
Unsigned	Data is treated as an array of unsigned 8-bit integers
XML	Data is treated as an MBCS XML string

See also

• AddUInt8Array(String, Byte[])
• AddUInt8Array(String, Byte[], LoggingFieldFormat)