PdhLookupPerfNameByIndexA 函数 (pdh.h)
返回与指定索引对应的性能对象名称或计数器名称。
语法
PDH_FUNCTION PdhLookupPerfNameByIndexA(
[in] LPCSTR szMachineName,
[in] DWORD dwNameIndex,
[out] LPSTR szNameBuffer,
[in, out] LPDWORD pcchNameBufferSize
);
参数
[in] szMachineName
Null-terminated 字符串,指定指定指定性能对象或计数器所在的计算机的名称。 计算机名称可由 DNS 名称或 IP 地址指定。 如果 NULL,则该函数使用本地计算机。
[in] dwNameIndex
性能对象或计数器的索引。
[out] szNameBuffer
调用方分配的缓冲区,用于接收性能对象或计数器的 null-terminated 名称。 如果 pcchNameBufferSize 为零,则设置为
[in, out] pcchNameBufferSize
szNameBuffer 缓冲区的大小,以 TCHAR为单位。 如果输入为零,则函数将返回PDH_MORE_DATA并将此参数设置为所需的缓冲区大小。 如果缓冲区大于所需大小,则函数会将此参数设置为所使用的缓冲区的实际大小。 如果输入上的指定大小大于零,但小于所需大小,则不应依赖返回的大小来重新分配缓冲区。
返回值
如果函数成功,它将返回ERROR_SUCCESS。
如果函数失败,则返回值为 系统错误代码 或 PDH 错误代码。 以下是可能的值。
返回代码 | 描述 |
---|---|
|
szNameBuffer 缓冲区不够大,无法包含计数器名称。 如果输入时 pcchNameBufferSize 为零,则预期返回值。 如果输入上的指定大小大于零,但小于所需大小,则不应依赖返回的大小来重新分配缓冲区。 |
|
参数无效或格式不正确。 例如,在某些版本中,如果输入上的指定大小大于零但小于所需大小,则可能会收到此错误。 |
言论
应调用此函数两次,第一次获取所需的缓冲区大小(将 szNameBuffer 设置为 NULL,pcchNameBufferSize 为 0),第二次获取数据。
Windows XP:必须指定缓冲区和缓冲区大小。 该函数将 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 [仅限桌面应用] |
目标平台 | 窗户 |
标头 | pdh.h |
库 | Pdh.lib |
DLL | Pdh.dll |