PdhEnumLogSetNamesA function (pdh.h)

Article
02/22/2024

Enumerates the names of the log sets within the DSN.

Syntax

PDH_FUNCTION PdhEnumLogSetNamesA(
  [in]      LPCSTR  szDataSource,
  [out]     PZZSTR  mszDataSetNameList,
  [in, out] LPDWORD pcchBufferLength
);

Parameters

[in] szDataSource

Null-terminated string that specifies the DSN.

[out] mszDataSetNameList

Caller-allocated buffer that receives the list of null-terminated log set names. The list is terminated with a null-terminator character. Set to NULL if the pcchBufferLength parameter is zero.

[in, out] pcchBufferLength

Size of the mszLogSetNameList buffer, in TCHARs. If zero on input, the function returns PDH_MORE_DATA and sets this parameter to the required buffer size. If the buffer is larger than the required size, the function sets this parameter to the actual size of the buffer that was used. If the specified size on input is greater than zero but less than the required size, you should not rely on the returned size to reallocate the buffer.

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_MORE_DATA	The size of the mszLogSetNameList buffer is too small to contain all the data. This return value is expected if pcchBufferLength is zero on input. If the specified size on input is greater than zero but less than the required size, you should not rely on the returned size to reallocate the buffer.
PDH_INVALID_ARGUMENT	A parameter is not valid. For example, on some releases you could receive this error if the specified size on input is greater than zero but less than the required size.

Remarks

You should call this function twice, the first time to get the required buffer size (set mszLogSetNameList to NULL and pcchBufferLength to 0), and the second time to get the data.

Note

The pdh.h header defines PdhEnumLogSetNames 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

Share via