通过

PdhParseInstanceNameA 函数 （pdh.h）

  • 项目

分析实例字符串的元素。

语法

PDH_FUNCTION PdhParseInstanceNameA(
  [in]      LPCSTR  szInstanceString,
  [out]     LPSTR   szInstanceName,
  [in, out] LPDWORD pcchInstanceNameLength,
  [out]     LPSTR   szParentName,
  [in, out] LPDWORD pcchParentNameLength,
  [out]     LPDWORD lpIndex
);

参数

[in] szInstanceString

Null-terminated 字符串，指定要分析到各个组件的实例字符串。 此字符串可以包含以下格式，长度小于MAX_PATH个字符：

  • 实例
  • instance#index
  • parent/instance
  • parent/instance#index

[out] szInstanceName

接收 null终止实例名称的调用方分配的缓冲区。 如果 pcchInstanceNameLength 为零，则设置为 NULL。

[in, out] pcchInstanceNameLength

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

[out] szParentName

如果指定了父实例，则调用方分配的缓冲区接收 null-terminated 名称。 如果 pcchParentNameLength 为零，则设置为 NULL。

[in, out] pcchParentNameLength

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

[out] lpIndex

实例的索引值。 如果字符串中不存在索引项，则此值为零。 此参数可以 NULL。

返回值

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

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

返回代码 描述
PDH_INVALID_ARGUMENT
 参数无效。 例如，在某些版本中，如果输入上的指定大小大于零但小于所需大小，则可能会收到此错误。
PDH_MORE_DATA
 一个或两个字符串缓冲区太小，无法包含数据。 如果输入上的相应大小缓冲区为零，则预期返回值。 如果输入上的指定大小大于零，但小于所需大小，则不应依赖返回的大小来重新分配缓冲区。
PDH_INVALID_INSTANCE
 实例字符串的格式不正确、长度超过MAX_PATH个字符或无法分析。

言论

应调用此函数两次，第一次获取所需的缓冲区大小（将缓冲区设置为 NULL 和缓冲区大小设置为 0），第二次获取数据。

注意

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

要求

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

另请参阅

PdhMakeCounterPath