pdhLookupPerfNameByIndexA 函数 (pdh.h)

  • 项目

返回与指定索引对应的性能对象名称或计数器名称。

语法

PDH_FUNCTION PdhLookupPerfNameByIndexA(
  [in]      LPCSTR  szMachineName,
  [in]      DWORD   dwNameIndex,
  [out]     LPSTR   szNameBuffer,
  [in, out] LPDWORD pcchNameBufferSize
);

参数

[in] szMachineName

以 Null 结尾的字符串，指定指定性能对象或计数器所在的计算机的名称。 可以通过 DNS 名称或 IP 地址指定计算机名称。 如果 为 NULL，则该函数使用本地计算机。

[in] dwNameIndex

性能对象或计数器的索引。

[out] szNameBuffer

调用方分配的缓冲区，用于接收性能对象或计数器的 以 null 结尾的名称。 如果 pcchNameBufferSize 为零，则设置为 NULL。

[in, out] pcchNameBufferSize

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

返回值

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

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

返回代码 说明
PDH_MORE_DATA
 szNameBuffer 缓冲区不够大，无法包含计数器名称。 如果 pcchNameBufferSize 在输入时为零，则此返回值是预期值。 如果输入的指定大小大于零但小于所需大小，则不应依赖返回的大小来重新分配缓冲区。
PDH_INVALID_ARGUMENT
 参数无效或格式不正确。 例如，在某些版本中，如果输入的指定大小大于零但小于所需大小，则可能会收到此错误。

注解

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

Windowsxp： 必须指定缓冲区和缓冲区大小。 函数将 pcchNameBufferSize 设置为所需大小或所用缓冲区的大小。 如果缓冲区太小，函数将返回PDH_INSUFFICIENT_BUFFER而不是PDH_MORE_DATA。 最大字符串大小（以字节为单位）PDH_MAX_COUNTER_NAME * sizeof (TCHAR) 。

指定的索引值必须与计算机上加载的对象或计数器关联的索引值之一匹配。 索引/名称值对存储在以下注册表位置 的计数器 注册表值中。

HKEY_LOCAL_MACHINE
   \SOFTWARE
      \Microsoft
         \Windows NT
            \CurrentVersion
               \Perflib
                  Last Counter = highest counter index
                  Last Help = highest help index
                  \009
                     Counters = 2 System 4 Memory...
                     Help = 3 The System Object Type...
                  \supported language, other than English
                     Counters = ...
                     Help = ...

注意

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

要求

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

另请参阅

PdhLookupPerfIndexByName