TelemetrySession.TryAddCommonProperty(String, Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Telemetry

Assembly:: Microsoft.VisualStudio.Telemetry.dll

Package:: Microsoft.VisualStudio.Telemetry v17.11.20

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.

Attempts to add a single property key and value that may be common to all events for the session but should not have the Context prefix. Properties are not persisted between sessions. To add multiple properties see AddCommonPropertyRange(IDictionary<String,Object>)

public bool TryAddCommonProperty (string propertyName, object propertyValue);

member this.TryAddCommonProperty : string * obj -> bool

Public Function TryAddCommonProperty (propertyName As String, propertyValue As Object) As Boolean

Parameters

propertyName: String

propertyValue: Object

Returns

Boolean

true if the key/value pair was added, false if the key already existed.

Exceptions

ArgumentNullException

Thrown when properties, key, or value is null

ArgumentException

Thrown when property key or value is null

Applies to

Share via