PdhAddEnglishCounterA function (pdh.h)
Adds the specified language-neutral counter to the query.
PDH_FUNCTION PdhAddEnglishCounterA( [in] PDH_HQUERY hQuery, [in] LPCSTR szFullCounterPath, [in] DWORD_PTR dwUserData, [out] PDH_HCOUNTER *phCounter );
Handle to the query to which you want to add the counter. This handle is returned by the PdhOpenQuery function.
Null-terminated string that contains the counter path. For details on the format of a counter path, see Specifying a Counter Path. The maximum length of a counter path is PDH_MAX_COUNTER_PATH.
User-defined value. This value becomes part of the counter information. To retrieve this value later, call the PdhGetCounterInfo function and access the dwQueryUserData member of the PDH_COUNTER_INFO structure.
Handle to the counter that was added to the query. You may need to reference this handle in subsequent calls.
Return ERROR_SUCCESS if the function succeeds.
||The counter path could not be parsed or interpreted.|
||Unable to find the specified counter on the computer or in the log file.|
||The counter path is empty.|
||The path did not contain a computer name and the function was unable to retrieve the local computer name.|
||Unable to find the specified object on the computer or in the log file.|
||Unable to determine the calculation function to use for this counter.|
||One or more arguments are not valid.|
||The query handle is not valid.|
||Unable to allocate memory required to complete the function.|
This function provides a language-neutral way to add performance counters to the query. In contrast, the counter path that you specify in the PdhAddCounter function must be localized.
If a counter instance is specified that does not yet exist, PdhAddEnglishCounter does not report an error condition. Instead, it returns ERROR_SUCCESS. The reason for this behavior is that it is not known whether a nonexistent counter instance has been specified or whether one will exist but has not yet been created.
To remove the counter from the query, use the PdhRemoveCounter function.
- Make a query
- Use PdhAddEnglishCounter with the string containing wildcards
- Use PdhGetCounterInfo on the counter handle returned by PdhAddEnglishCounter to get a localized full path (szFullPath.) This string still contains wildcards, but the non-wildcard parts are now localized.
- Use PdhExpandWildCardPath to expand the wildcards.
- Use PdhAddCounter on each of the resulting paths
The pdh.h header defines PdhAddEnglishCounter as an alias which 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 not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
|Minimum supported client||Windows Vista [desktop apps only]|
|Minimum supported server||Windows Server 2008 [desktop apps only]|