Edit

PdhVbAddCounter function

  • Article

The PdhVbAddCounter function creates a counter entry in the specified query object, and returns a handle to that counter upon successful completion.

Important

The function that this topic describes may be altered or unavailable in the future. Instead, Microsoft recommends that you use the functions described in Performance Counters Functions.

Function PdhVbAddCounter( _ ByVal QueryHandle As Long, _ ByVal CounterPath As String, _ ByVal CounterHandle As Long _ ) As Long

Parameters

QueryHandle

ID of the query to which this counter is to be assigned. This value is returned by the PdhVbOpenQuery function.

CounterPath

Text string that specifies 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

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 value

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 system error code or a PDH error code. The following are possible values.

Return code Description
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 computer 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.

Requirements

Requirement Value
Minimum supported client
 Windows XP [desktop apps only]
Minimum supported server
 Windows Server 2003 [desktop apps only]
Library
Pdh.lib
DLL
Pdh.dll

See also

PdhVbOpenQuery