pdhGetCounterInfoA 函数 (pdh.h)

  • 项目

检索有关计数器的信息，例如数据大小、计数器类型、路径和用户提供的数据值。

语法

PDH_FUNCTION PdhGetCounterInfoA(
  [in]      PDH_HCOUNTER        hCounter,
  [in]      BOOLEAN             bRetrieveExplainText,
  [in, out] LPDWORD             pdwBufferSize,
  [out]     PPDH_COUNTER_INFO_A lpBuffer
);

参数

[in] hCounter

要从中检索信息的计数器的句柄。 PdhAddCounter 函数返回此句柄。

[in] bRetrieveExplainText

确定是否检索说明文本。 如果将此参数设置为 TRUE，则会检索计数器的说明文本。 如果将此参数设置为 FALSE，则返回的缓冲区中的字段为 NULL。

[in, out] pdwBufferSize

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

[out] lpBuffer

接收 PDH_COUNTER_INFO 结构的调用方分配的缓冲区。 结构长度可变，因为字符串数据追加到结构的固定格式部分的末尾。 这样做是为了在调用方分配的单个缓冲区中返回所有数据。 如果 pdwBufferSize 为零，则设置为 NULL。

返回值

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

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

返回代码 说明
PDH_INVALID_ARGUMENT
 参数无效或格式不正确。 例如，在某些版本中，如果输入的指定大小大于零但小于所需大小，则可能会收到此错误。
PDH_INVALID_HANDLE
 计数器句柄无效。
PDH_MORE_DATA
 lpBuffer 缓冲区太小，无法保存计数器信息。 如果 pdwBufferSize 在输入时为零，则预期返回值。 如果输入的指定大小大于零但小于所需大小，则不应依赖返回的大小来重新分配缓冲区。

注解

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

注意

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

要求

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

另请参阅

PDH_COUNTER_INFO