通过

pdhExpandCounterPathA 函数 (pdh.h)

  • 项目

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

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

语法

PDH_FUNCTION PdhExpandCounterPathA(
  [in]      LPCSTR  szWildCardPath,
  [out]     PZZSTR  mszExpandedPathList,
  [in, out] LPDWORD pcchPathListLength
);

参数

[in] szWildCardPath

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

[out] mszExpandedPathList

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

[in, out] pcchPathListLength

mszExpandedPathList 缓冲区的大小（以 TCHAR 为单位）。 如果输入为零，则函数返回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 (实例) \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 [仅限桌面应用]
目标平台 Windows
标头 pdh.h
Library Pdh.lib
DLL Pdh.dll

另请参阅

PdhExpandWildCardPath

PdhMakeCounterPath