CustomSampledMetricDefinition Constructor(String,String,String,MetricSampleType,String,String)

In This Topic

Create a new metric definition for the active log.

Syntax

Visual Basic
C#

'Declaration
 
Public Function New( _
   ByVal metricTypeName As String, _
   ByVal categoryName As String, _
   ByVal counterName As String, _
   ByVal metricSampleType As MetricSampleType, _
   ByVal unitCaption As String, _
   ByVal description As String _
)

public CustomSampledMetricDefinition( 
   string metricTypeName,
   string categoryName,
   string counterName,
   MetricSampleType metricSampleType,
   string unitCaption,
   string description
)

Parameters

metricTypeName: The unique metric type
categoryName: The name of the category with which this definition is associated.
counterName: The name of the definition within the category.
metricSampleType: The type of data captured for each metric under this definition.
unitCaption: The display caption for the calculated values captured under this metric.
description: A description of what is tracked by this metric, suitable for end-user display.

Remarks

At any one time there should only be one metric definition with a given combination of metric type, category, and counter name. These values together are used to correlate metrics between sessions. The metric definition will automatically be added to the provided collection.

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

CustomSampledMetricDefinition Class
CustomSampledMetricDefinition Members
Overload List

Send Feedback