通过

PdhExpandWildCardPathHA 函数 （pdh.h）

  • 项目

检查指定的计算机或日志文件，并返回与包含通配符的给定计数器路径匹配的计数器路径。

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

语法

PDH_FUNCTION PdhExpandWildCardPathHA(
  [in]      PDH_HLOG hDataSource,
  [in]      LPCSTR   szWildCardPath,
  [out]     PZZSTR   mszExpandedPathList,
  [in, out] LPDWORD  pcchPathListLength,
  [in]      DWORD    dwFlags
);

参数

[in] hDataSource

PdhBindInputDataSource 函数返回的数据源的句柄。

[in] szWildCardPath

Null-terminated 字符串，用于指定要展开的计数器路径。 计数器路径的最大长度为PDH_MAX_COUNTER_PATH。

如果 hDataSource 是实时数据源，则函数将在路径中指定的计算机中搜索匹配项。 如果路径未指定计算机，该函数将搜索本地计算机。

[out] mszExpandedPathList

调用方分配的缓冲区，接收 与 szWildCardPath中的通配符规范匹配的 null终止计数器路径的列表。 该列表由两个 NULL 字符终止。 如果 pcchPathListLength 为零，则设置为 NULL。

[in, out] pcchPathListLength

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

注意 必须在 Windows XP 上将一个添加到所需大小。
 

[in] dwFlags

指示不展开的通配符的标志。 可以指定一个或多个标志。

价值 意义
PDH_NOEXPANDCOUNTERS
 如果路径包含计数器名称的通配符，请不要展开计数器名称。
PDH_NOEXPANDINSTANCES
 如果路径包含父实例、实例名称或实例索引的通配符，请不要展开实例名称。
PDH_REFRESHCOUNTERS
 刷新计数器列表。

返回值

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

如果函数失败，则返回值为 系统错误代码 或 PDH 错误代码。

返回代码 描述
PDH_MORE_DATA
 mszExpandedPathList 缓冲区不够大，无法包含路径列表。 如果输入时 pcchPathListLength 为零，则预期返回值。 如果输入上的指定大小大于零，但小于所需大小，则不应依赖返回的大小来重新分配缓冲区。
PDH_INVALID_ARGUMENT
 参数无效。 例如，在某些版本中，如果输入上的指定大小大于零但小于所需大小，则可能会收到此错误。
PDH_MEMORY_ALLOCATION_FAILURE
 无法分配内存以支持此函数。
PDH_CSTATUS_NO_OBJECT
 无法在计算机或日志文件中找到指定的对象。

言论

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

PdhExpandWildCardPathH 不同于 PdhExpandCounterPath，方法如下：

  1. 允许你控制哪些通配符已展开。
  2. 日志文件的内容可用作计数器名称的源。
常规计数器路径格式如下所示：

\computer\object（parent/instance#index）\counter

计数器路径的父、实例、索引和计数器组件可能包含有效名称或通配符。 所有计数器都不需要计算机、父组件、实例和索引组件。

下面是可能格式的列表：

  • \\computer\object（parent/instance#index）\counter
  • \\computer\object（parent/instance）\counter
  • \\computer\object（instance#index）\counter
  • \\computer\object（instance）\counter
  • \\computer\object\counter
  • \object（parent/instance#index）\counter
  • \object（parent/instance）\counter
  • \object（instance#index）\counter
  • \object（instance）\counter
  • \object\counter
使用星号 • 作为通配符，例如 \object\\counter。

如果在父名称中指定了通配符，将返回与指定实例和计数器字段匹配的指定对象的所有实例。 例如 \object（*/instance）\counter。

如果在实例名称中指定了通配符，则当与指定索引对应的所有实例名称与通配符匹配时，将返回指定对象和父对象的所有实例。 例如，\object（parent/*）\counter。

如果在计数器名称中指定了通配符，则返回指定对象的所有计数器。

部分计数器路径字符串匹配（例如，支持“pro*”）。

在 Windows Vista 之前 ：不支持 部分通配符匹配。

注意

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

要求

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

另请参阅

PdhBindInputDataSourceA 函数PdhEnumObjectItemsHA 函数PdhEnumObjectsHA 函数PdhExpandCounterPathA 函数