PdhEnumLogSetNames function

Enumerates the names of the log sets within the DSN.

Syntax


PDH_STATUS PdhEnumLogSetNames(
  _In_    LPCTSTR szDataSource,
  _Out_   LPTSTR  mszLogSetNameList,
  _Inout_ LPDWORD pcchBufferLength
);

Parameters

szDataSource [in]

Null-terminated string that specifies the DSN.

mszLogSetNameList [out]

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.

pcchBufferLength [in, out]

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 codeDescription
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.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Pdh.h

Library

Pdh.lib

DLL

Pdh.dll

Unicode and ANSI names

PdhEnumLogSetNamesW (Unicode) and PdhEnumLogSetNamesA (ANSI)

 

 

Show: