Export (0) Print
Expand All

PerformanceCounterCategory.Delete Method

Updated: August 2010

Removes the category and its associated counters from the local computer.

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

public static void Delete(
	string categoryName
)

Parameters

categoryName
Type: System.String

The name of the custom performance counter category to delete.

ExceptionCondition
ArgumentNullException

The categoryName parameter is null.

ArgumentException

The categoryName parameter has invalid syntax. It might contain backslash characters ("\") or have length greater than 80 characters.

Win32Exception

A call to an underlying system API failed.

InvalidOperationException

The category cannot be deleted because it is not a custom category.

UnauthorizedAccessException

Code that is executing without administrative privileges attempted to read a performance counter.

You can delete only custom performance counter categories from the system. You cannot delete a counter from a category. To do so, delete the category and recreate the category with the counters you want to retain. To avoid an exception, confirm that the category exists before you attempt to delete it.

NoteNote:

To read performance counters in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges.

To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group.

In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator.

The following code example uses the Delete method to delete a PerformanceCounterCategory and the PerformanceCounter objects that it contains.

public static void Main(string[] args)
{
    string categoryName = "";

    // Copy the supplied argument into the local variable. 
    try
    {
        categoryName = args[0];
    }
    catch (Exception ex)
    {
        Console.WriteLine("Missing argument identifying category to be deleted.");
    }

    // Delete the specified category. 
    try
    {
        if (PerformanceCounterCategory.Exists(categoryName))
        {
            PerformanceCounterCategory.Delete(categoryName);
            Console.WriteLine("Category \"{0}\" deleted from this computer.", categoryName);
        }
        else
        {
            Console.WriteLine("Category name not found");
        }

    }
    catch (Exception ex)
    {
        Console.WriteLine("Unable to delete " +
            "category \"{0}\" from this computer:" + "\n" + ex.Message, categoryName);
    }
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Date

History

Reason

August 2010

Updated example, and added information about checking if the category exists before deleting.

Customer feedback.

Community Additions

ADD
Show:
© 2014 Microsoft