PdhEnumLogSetNamesW 函数 (pdh.h)

枚举 DSN 中日志集的名称。

语法

PDH_FUNCTION PdhEnumLogSetNamesW(
  [in]      LPCWSTR szDataSource,
  [out]     PZZWSTR mszDataSetNameList,
  [in, out] LPDWORD pcchBufferLength
);

参数

[in] szDataSource

指定 DSN 的 null终止字符串。

[out] mszDataSetNameList

调用方分配的缓冲区,该缓冲区接收 null-terminated 日志集名称的列表。 该列表以 null-terminateor 字符 终止。 如果 pcchBufferLength 参数为零,则设置为 NULL

[in, out] pcchBufferLength

TCHArmszLogSetNameList 缓冲区的大小。 如果输入为零,则函数将返回PDH_MORE_DATA并将此参数设置为所需的缓冲区大小。 如果缓冲区大于所需大小,则函数会将此参数设置为所使用的缓冲区的实际大小。 如果输入上的指定大小大于零,但小于所需大小,则不应依赖返回的大小来重新分配缓冲区。

返回值

如果函数成功,它将返回ERROR_SUCCESS。

如果函数失败,则返回值为 系统错误代码PDH 错误代码。 以下是可能的值。

返回代码 描述
PDH_MORE_DATA
mszLogSetNameList 缓冲区的大小太小,无法包含所有数据。 如果输入时 pcchBufferLength 为零,则预期返回值。 如果输入上的指定大小大于零,但小于所需大小,则不应依赖返回的大小来重新分配缓冲区。
PDH_INVALID_ARGUMENT
参数无效。 例如,在某些版本中,如果输入上的指定大小大于零但小于所需大小,则可能会收到此错误。

言论

应调用此函数两次,第一次获取所需的缓冲区大小(mszLogSetNameList 设置为 NULL并将 pcchBufferLength 设置为 0),第二次获取数据。

注意

pdh.h 标头将 PdhEnumLogSetNames 定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的 约定。

要求

要求 价值
最低支持的客户端 Windows XP [仅限桌面应用]
支持的最低服务器 Windows Server 2003 [仅限桌面应用]
目标平台 窗户
标头 pdh.h
Pdh.lib
DLL Pdh.dll