PdhGetDefaultPerfCounterHA 函数 (pdh.h)

  • 项目

检索指定对象的默认计数器的名称。 此名称可用于在“浏览计数器”对话框中设置初始计数器选择。

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

语法

PDH_FUNCTION PdhGetDefaultPerfCounterHA(
  [in]      PDH_HLOG hDataSource,
  [in]      LPCSTR   szMachineName,
  [in]      LPCSTR   szObjectName,
  [out]     LPSTR    szDefaultCounterName,
  [in, out] LPDWORD  pcchBufferSize
);

参数

[in] hDataSource

应为 NULL。

如果指定日志文件句柄， 则 szDefaultCounterName 将为 空 字符串。

[in] szMachineName

以 Null 结尾的字符串，指定用于验证对象名称的计算机的名称。 如果 为 NULL，则使用本地计算机来验证名称。

[in] szObjectName

以 Null 结尾的字符串，指定要检索其默认计数器名称的对象的名称。

[out] szDefaultCounterName

调用方分配的缓冲区，用于接收 以 null 结尾的默认计数器名称。 如果 pcchBufferSize 为零，则设置为 NULL。

[in, out] pcchBufferSize

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

返回值

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

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

返回代码 说明
PDH_MORE_DATA
 szDefaultCounterName 缓冲区太小，无法包含计数器名称。 如果 pcchBufferSize 在输入时为零，则此返回值应为预期值。 如果输入的指定大小大于零但小于所需大小，则不应依赖返回的大小来重新分配缓冲区。
PDH_INVALID_ARGUMENT
 必需的参数无效。 例如，在某些版本中，如果输入的指定大小大于零但小于所需大小，则可能会收到此错误。
PDH_MEMORY_ALLOCATION_FAILURE
 无法分配内存以完成函数。
PDH_CSTATUS_NO_MACHINE
 指定的计算机处于脱机状态或不可用。
PDH_CSTATUS_NO_COUNTERNAME
 无法读取或找到默认计数器名称。
PDH_CSTATUS_NO_OBJECT
 找不到指定的对象。
PDH_CSTATUS_NO_COUNTER
 对象未指定默认计数器。

注解

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

注意

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

要求

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

另请参阅

PdhBindInputDataSource

PdhBrowseCountersH

PdhGetDefaultPerfObjectH