Server.EnumPerformanceCounters Method (String, String, String)

Article
12/03/2008

Enumerates a list of performance counters that are supported by the instance of Microsoft SQL Server for a specified object, for a specified counter, and on the specified instance of SQL Server.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Function EnumPerformanceCounters ( _
    objectName As String, _
    counterName As String, _
    instanceName As String _
) As DataTable

public DataTable EnumPerformanceCounters (
    string objectName,
    string counterName,
    string instanceName
)

public:
DataTable^ EnumPerformanceCounters (
    String^ objectName, 
    String^ counterName, 
    String^ instanceName
)

public DataTable EnumPerformanceCounters (
    String objectName, 
    String counterName, 
    String instanceName
)

public function EnumPerformanceCounters (
    objectName : String, 
    counterName : String, 
    instanceName : String
) : DataTable

Parameters

objectName
A String value that specifies the object on which to limit the results.

counterName
A String value that specifies the counter name on which to limit the results.

instanceName
A String value that specifies the instance of SQL Server.

Return Value

A DataTable object value that contains a list of performance counters supported by the instance of SQL Server. The table describes the different columns of the returned DataTable.

Column	Data type	Description
ObjectName	String	The name of the performance counter object. The SqlServer.ExecStatistics object, for example.
CounterName	String	The name of the performance counter. The Distributed Query counter, for example.
InstanceName	String	The name of the measurement to be taken. The Exec started per second instance, for example.

Remarks

Updated text:

This method enumerates all the performance counters available in SQL Server that you could use to create a performance alert. You can also see the performance counters listed in Using SQL Server Objects.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

How to: Use an Enumeration Method that Returns a DataTable Object in Visual Basic .NET

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms