UnitCaption Property (SampledMetric)

In This Topic

The display caption for the units this metric's values represent, or null for unit-less values.

Syntax

Visual Basic
C#

'Declaration
 
Public ReadOnly Property UnitCaption As String

public string UnitCaption {get;}

Remarks

Unit caption is used in the Analyst during charting and graphing to allow metrics that share the same units to be displayed on the same axis. Comparison is case insensitive, but otherwise done as a normal string compare.

Normally unit captions do not include aggregation text, such as Average, Min or Max to support the best axis grouping.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SampledMetric Class
SampledMetric Members

Send Feedback