PerformanceCounterCategory.CategoryName Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

public string CategoryName { get; set; }

Property Value

Type: System.String

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

Exception Condition
ArgumentException

The CategoryName is an empty string ("").

ArgumentNullException

The CategoryName is null.

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);
    }
}

PerformanceCounterPermission

for reading performance counter categories. Associated enumeration: PerformanceCounterPermissionAccess.Read.

.NET Framework
Available since 1.1
Return to top
Show: