PdhAddCounter (VB)

The Visual Basic PdhAddCounter function creates a counter entry in the specified query object, and returns the handle for that counter upon successful completion.

PdhAddCounter(
  ByVal QueryHandle as Long,  
  ByVal CounterPath as String,  
  ByRef CounterHandle as Long)  
as Long
 

Parameters

QueryHandle

The ID of the query to assign this counter to. This must be a value returned by a successful call to PdhOpenQuery.

CounterPath

The text string containing the name of the counter path to add to the query. The contents of this string must be a valid counter path, as obtained from the counter browser or other source.

CounterHandle

The unique reference that identifies this counter in the query. This variable must be initialized to zero before the function is called. It contains a valid value on return only if the function completes successfully.

Return Values

If the function succeeds, it returns a Long integer equal to ERROR_SUCCESS and a new handle in the CounterHandle variable.

If the function fails, the return value is a PDH error status defined in pdhdefs.txt. The following are possible error values:

PDH_INVALID_ARGUMENT

One or more of the arguments is invalid or incorrect.

PDH_MEMORY_ALLOCATION_FAILURE

A memory buffer could not be allocated.

PDH_INVALID_HANDLE

The query handle is not valid.

PDH_CSTATUS_NO_COUNTER

The specified counter was not found.

PDH_CSTATUS_NO_OBJECT

The specified object could not be found.

PDH_CSTATUS_NO_MACHINE

A machine entry could not be created.

PDH_CSTATUS_BAD_COUNTERNAME

An empty counter name path string was passed in.

PDH_FUNCTION_NOT_FOUND

The calculation function for this counter could not be determined.

See Also

Performance Data Helper Overview, Performance Data Functions