PdhMakeCounterPathA 函数 (pdh.h)

使用 PDH_COUNTER_PATH_ELEMENTS 结构中指定的成员创建完整计数器路径。

语法

PDH_FUNCTION PdhMakeCounterPathA(
  [in]      PPDH_COUNTER_PATH_ELEMENTS_A pCounterPathElements,
  [out]     LPSTR                        szFullPathBuffer,
  [in, out] LPDWORD                      pcchBufferSize,
  [in]      DWORD                        dwFlags
);

参数

[in] pCounterPathElements

包含用于构成路径的成员的 PDH_COUNTER_PATH_ELEMENTS 结构。 只有 szObjectNameszCounterName 成员是必需的,其他成员是可选的。

如果实例名称成员 NULL,则路径将不包含实例引用,并且将忽略 szParentInstancedwInstanceIndex 成员。

[out] szFullPathBuffer

调用方分配的缓冲区,接收 null-terminated 计数器路径。 计数器路径的最大长度为PDH_MAX_COUNTER_PATH。 如果 pcchBufferSize 为零,则设置为 NULL

[in, out] pcchBufferSize

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

[in] dwFlags

输入和输出计数器值的格式。 可以指定以下值之一。

价值 意义
PDH_PATH_WBEM_RESULT
将 PDH 路径转换为 WMI 类和属性名称格式。
PDH_PATH_WBEM_INPUT
将 WMI 类和属性名称转换为 PDH 路径。
0
返回 PDH 格式的路径,例如 \\computer\object(parent/instance#index)\counter。

返回值

如果函数成功,它将返回ERROR_SUCCESS。

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

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

言论

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

注意

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

要求

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

另请参阅

PDH_COUNTER_PATH_ELEMENTS

PdhParseCounterPath