PerformanceCounter.CounterHelp Property

Gets the description for this performance counter.

Namespace: System.Diagnostics
Assembly: System (in system.dll)

public string CounterHelp { get; }
/** @property */
public String get_CounterHelp ()

public function get CounterHelp () : String

Property Value

A description of the item or quantity that this performance counter measures.

Exception typeCondition

InvalidOperationException

The PerformanceCounter instance is not associated with a performance counter.

-or-

The InstanceLifetime property is set to Process when using global shared memory.

PlatformNotSupportedException

The platform is Windows 98 or Windows Millennium Edition (Me), which does not support performance counters.

The Add Counters dialog box of the Performance Counter Manager MMC snap in displays the CounterHelp text when a user selects a counter from the counters list and clicks the Explain button.

When you create a new counter, use the CounterHelp text to describe what the counter monitors do so the user can determine whether to add the counter to the System Monitor's display.

NoteNote

If the value for the InstanceLifetime property is Process and the performance counter category was created with .NET Framework version 1.0 or 1.1, an InvalidOperationException is thrown. Performance counter categories created with earlier versions use global shared memory, and the value for InstanceLifetime must be Global. If the category is not used by applications running on versions 1.0 or 1.1 of the .NET Framework, delete and recreate the category.

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show: