通过

PdhExpandCounterPathW 函数 （pdh.h）

  • 项目

检查与计数器路径中的通配符字符串匹配的计数器和计数器实例的指定计算机（或本地计算机（如果未指定）。

注释 此函数由 PdhExpandWildCardPath 函数取代。
 

语法

PDH_FUNCTION PdhExpandCounterPathW(
  [in]      LPCWSTR szWildCardPath,
  [out]     PZZWSTR mszExpandedPathList,
  [in, out] LPDWORD pcchPathListLength
);

参数

[in] szWildCardPath

Null终止的字符串，其中包含要展开的计数器路径。 该函数在路径中指定的计算机中搜索匹配项。 如果路径未指定计算机，该函数将搜索本地计算机。 计数器路径的最大长度为PDH_MAX_COUNTER_PATH。

[out] mszExpandedPathList

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

[in, out] pcchPathListLength

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

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

返回值

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

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

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

言论

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

常规计数器路径格式如下所示：

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

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

必须使用的计数器路径由计数器本身确定。 例如，LogicalDisk 对象具有实例索引，因此必须提供 #index 或通配符。 因此，可以使用以下格式：

\LogicalDisk（/#*）*

相比之下，Process 对象不需要实例索引。 因此，可以使用以下格式：

\Process\\ID Process

下面是可能格式的列表：

  • \\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
如果在父名称中指定了通配符，将返回与指定实例和计数器字段匹配的指定对象的所有实例。

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

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

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

例子

以下示例演示如何使用此函数。


#include <windows.h>
#include <stdio.h>
#include <stdlib.h>
#include <pdh.h>
#include <pdhmsg.h>

#pragma comment(lib, "pdh.lib")

CONST PWSTR WILDCARD_PATH = L"\\Processor(*)\\*";

void wmain(void)
{
    PDH_STATUS Status;
    PWSTR EndOfPaths;
    PWSTR Paths = NULL;
    DWORD BufferSize = 0;

    Status = PdhExpandCounterPath(WILDCARD_PATH, Paths, &BufferSize);

    while (Status == PDH_MORE_DATA) 
    {
        Paths = (PWSTR)malloc(BufferSize * sizeof(WCHAR));
        Status = PdhExpandCounterPath(WILDCARD_PATH, Paths, &BufferSize);
    }

    if (Status != ERROR_SUCCESS) 
    {
        wprintf(L"\nPdhExpandCounterPath failed with status 0x%x", Status);
        goto Cleanup;
    }

    if (Paths == NULL) 
    {
        wprintf(L"\nThe counter path %s cannot be expanded.", WILDCARD_PATH);
        goto Cleanup;
    }

    EndOfPaths = Paths + BufferSize;

    // On Vista and later operating systems, the buffer is terminated with two 
    // null-terminator characters; however, on earlier systems, the buffer is
    // not terminated with two null-terminator characters. This covers both cases.
    for (PWSTR p = Paths; ((p != EndOfPaths) && (*p != L'\0')); p += wcslen(p) + 1) 
    {
        wprintf(L"\n%s", p);
    }

Cleanup:
    if (Paths) 
    {
        free(Paths);
    }
}

注意

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

要求

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

另请参阅

PdhExpandWildCardPath

PdhMakeCounterPath