Edit

Share via

PdhValidatePathA function (pdh.h)

  • Article

Validates that the counter is present on the computer specified in the counter path.

Syntax

PDH_FUNCTION PdhValidatePathA(
  [in] LPCSTR szFullPathBuffer
);

Parameters

[in] szFullPathBuffer

Null-terminated string that contains the counter path to validate. The maximum length of a counter path is PDH_MAX_COUNTER_PATH.

Return value

If the function succeeds, it returns ERROR_SUCCESS.

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_CSTATUS_NO_INSTANCE
 The specified instance of the performance object was not found.
PDH_CSTATUS_NO_COUNTER
 The specified counter was not found in the performance object.
PDH_CSTATUS_NO_OBJECT
 The specified performance object was not found on the computer.
PDH_CSTATUS_NO_MACHINE
 The specified computer could not be found or connected to.
PDH_CSTATUS_BAD_COUNTERNAME
 The counter path string could not be parsed.
PDH_MEMORY_ALLOCATION_FAILURE
 The function is unable to allocate a required temporary buffer.

Remarks

Note

The pdh.h header defines PdhValidatePath as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

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

See also

PdhMakeCounterPath