LoggingOptions.Tags Property

Definition

Gets or sets the user-defined metadata value attached to an event.

public:
 property int Tags { int get(); void set(int value); };
int Tags();

void Tags(int value);
public int Tags { get; set; }
var int32 = loggingOptions.tags;
loggingOptions.tags = int32;
Public Property Tags As Integer

Property Value

Int32

int

The tag.

Remarks

The top four bits are reserved and must be set to zero (0).

Up to twenty-eight bits of user-defined information can be attached to an event as metadata. For example, user-defined metadata could be defined to act as instructions to a custom event processing tool to control event sampling, throttling, and so on.

For efficiency reasons, tags should be used for infrequently-changing metadata and not frequently-changing data.

Applies to