PerformanceCounterCategory.CategoryName Property

Definition

Namespace:

System.Diagnostics

Assembly:

System.Diagnostics.PerformanceCounter.dll

Package:

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

Source:

PerformanceCounterCategory.cs

Gets or sets the name of the performance object that defines this category.

public:
 property System::String ^ CategoryName { System::String ^ get(); void set(System::String ^ value); };

public string CategoryName { get; set; }

member this.CategoryName : string with get, set

Public Property CategoryName As String

Property Value

String

The name of the performance counter category, or performance object, with which to associate this PerformanceCounterCategory instance.

Exceptions

ArgumentException

The CategoryName is an empty string ("").

ArgumentNullException

The CategoryName is null.

Examples

The following code example creates a PerformanceCounterCategory with the PerformanceCounterCategory(). It prompts the user for the PerformanceCounterCategory and computer names, then sets the CategoryName and MachineName properties from the entered values. It then displays the values of the CategoryName, MachineName, and CategoryHelp properties, or it displays an error message if the PerformanceCounterCategory cannot be accessed.

public static void Main(string[] args)
{
    string categoryName = "";
    string machineName = "";
    PerformanceCounterCategory pcc = new PerformanceCounterCategory();

    // Prompt for fields and set the corresponding properties.
    while (categoryName.Length==0)
    {
        Console.Write("Please enter a non-blank category name: ");
        categoryName = Console.ReadLine().Trim();
        if (categoryName.Length>0)
        {
            pcc.CategoryName = categoryName;
        }
    }
    while (machineName.Length==0)
    {
        Console.Write("Enter a non-blank computer name ['.' for local]: ");
        machineName = Console.ReadLine().Trim();
        if (machineName.Length>0)
        {
            pcc.MachineName = machineName;
        }
    }

    // Display the properties of the PerformanceCounterCategory object.
    try
    {
        Console.WriteLine("  Category:  {0}", pcc.CategoryName);
        Console.WriteLine("  Computer:  {0}", pcc.MachineName);
        Console.WriteLine("  Help text: {0}", pcc.CategoryHelp);
    }
    catch(Exception ex)
    {
        Console.WriteLine("Error getting the properties of the " +
            "PerformanceCounterCategory object:");
        Console.WriteLine(ex.Message);
    }
}

Sub Main(ByVal args() As String)
    Dim categoryName As String = ""
    Dim machineName As String = ""
    Dim pcc As New PerformanceCounterCategory

    ' Prompt for fields and set the corresponding properties.
    While categoryName.Length = 0
        Console.Write("Please enter a non-blank category name: ")
        categoryName = Console.ReadLine().Trim
        If categoryName.Length > 0 Then
            pcc.CategoryName = categoryName
        End If
    End While
    While machineName.Length = 0
        Console.Write( _
            "Enter a non-blank computer name ['.' for local]: ")
        machineName = Console.ReadLine().Trim
        If machineName.Length > 0 Then
            pcc.MachineName = machineName
        End If
    End While

    ' Display the properties of the PerformanceCounterCategory object.
    Try
        Console.WriteLine("  Category:  {0}", pcc.CategoryName)
        Console.WriteLine("  Computer:  {0}", pcc.MachineName)
        Console.WriteLine("  Help text: {0}", pcc.CategoryHelp)
    Catch ex As Exception
        Console.WriteLine("Error getting the properties of the " & _
            "PerformanceCounterCategory object:")
        Console.WriteLine(ex.Message)
    End Try
End Sub

See also

• MachineName
• PerformanceCounter