CounterSet.CreateCounterSetInstance(String) Method

Definition

Namespace:

System.Diagnostics.PerformanceData

Assembly:

System.Diagnostics.PerformanceCounter.dll

Package:

System.Diagnostics.PerformanceCounter v9.0.0-rc.2.24473.5

Source:

CounterSet.cs

Creates an instance of the counter set.

public:
 System::Diagnostics::PerformanceData::CounterSetInstance ^ CreateCounterSetInstance(System::String ^ instanceName);

public System.Diagnostics.PerformanceData.CounterSetInstance CreateCounterSetInstance (string instanceName);

member this.CreateCounterSetInstance : string -> System.Diagnostics.PerformanceData.CounterSetInstance

Public Function CreateCounterSetInstance (instanceName As String) As CounterSetInstance

Parameters

instanceName

String

Name of the instance. The name must be unique.

Returns

CounterSetInstance

An instance of the counter set which will contain the counter data.

Exceptions

ArgumentException

The instance name is NULL.

InvalidOperationException

You must add counters to the counter set before creating an instance of the counter set.

Examples

For an example, see System.Diagnostics.PerformanceData.

Remarks

Call this method one time for single-instance counter sets and one or more times for multiple-instance counter sets.

The provider determines when it creates an instance. If the counter data is more static, the provider can create an instance at initialization time. For example, the number of processors on a computer would be considered static, so a provider that provides counter data for processors could create an instance for each processor on the computer at initialization time. For counters that are more dynamic, such as disk or process counters, the providers would create the new instances in response to a new USB device being added or a new process being created.

The provider should keep the counter data up-to-date at all times.