pdhEnumMachinesHA 函数 (pdh.h)

  • 项目

返回与日志文件中的计数器关联的计算机名称的列表。 计算机名称是在向查询添加计数器或调用 PdhConnectMachine 函数时指定的。 列出的计算机包括当前连接和联机的计算机，以及脱机或不返回性能数据的计算机。

此函数与 PdhEnumMachines 函数相同，只不过它支持对数据源使用句柄。

语法

PDH_FUNCTION PdhEnumMachinesHA(
  [in]      PDH_HLOG hDataSource,
  [out]     PZZSTR   mszMachineList,
  [in, out] LPDWORD  pcchBufferSize
);

参数

[in] hDataSource

PdhBindInputDataSource 函数返回的数据源的句柄。

[out] mszMachineList

调用方分配的缓冲区，用于接收包含计算机名称的 以 null 结尾的字符串的列表。 列表以两个 null 终止符字符结尾。 如果 pcchBufferLength 为零，则设置为 NULL。

[in, out] pcchBufferSize

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

返回值

如果函数成功，则返回ERROR_SUCCESS。

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

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

注解

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

注意

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

要求

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

另请参阅

PdhBindInputDataSource

PdhConnectMachine