Activity.SetTag(String, Object) Method

Definition

Namespace:

System.Diagnostics

Assembly:

System.Diagnostics.DiagnosticSource.dll

Source:

Activity.cs

Adds or update the activity tag with the input key and value.

public:
 System::Diagnostics::Activity ^ SetTag(System::String ^ key, System::Object ^ value);

public System.Diagnostics.Activity SetTag (string key, object? value);

member this.SetTag : string * obj -> System.Diagnostics.Activity

Public Function SetTag (key As String, value As Object) As Activity

Parameters

key

String

The tag key name.

value

Object

The tag value mapped to the input key.

Returns

Activity

this for convenient chaining.

Remarks

• If the input value is null:
  • If the collection has any tag with the same key, then this tag will get removed from the collection.
  • Otherwise, nothing will happen and the collection will not change.
• If the input value is not null:
  • If the collection has any tag with the same key, then the value mapped to this key will get updated with the new input value.
  • Otherwise, the key and value will get added as a new tag to the collection.