Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

PerformanceCounterCategory::ReadCategory Method ()

 

Reads all the counter and performance object instance data that is associated with this performance counter category.

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

public:
InstanceDataCollectionCollection^ ReadCategory()

Return Value

Type: System.Diagnostics::InstanceDataCollectionCollection^

An InstanceDataCollectionCollection that contains the counter and performance object instance data for the category.

Exception Condition
InvalidOperationException

The CategoryName property is null. The property might not have been set.

Win32Exception

A call to an underlying system API failed.

UnauthorizedAccessException

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

You must set the CategoryName property before you call ReadCategory.

Reading the entire category at once can be as efficient as reading a single counter because of the way that the system provides the data.

System_CAPS_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 creates a PerformanceCounterCategory for a specified PerformanceCounterCategory name. It then uses ReadCategory to return an InstanceDataCollectionCollection that contains instance data for all the instances of the PerformanceCounter objects within the PerformanceCounterCategory.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show:
© 2017 Microsoft