通过

PdhEnumObjectsA 函数 （pdh.h）

  • 项目

返回指定计算机上或指定日志文件中可用的对象列表。

若要对数据源使用句柄，请使用 PdhEnumObjectsH 函数。

语法

PDH_FUNCTION PdhEnumObjectsA(
  [in]      LPCSTR  szDataSource,
  [in]      LPCSTR  szMachineName,
  [out]     PZZSTR  mszObjectList,
  [in, out] LPDWORD pcchBufferSize,
  [in]      DWORD   dwDetailLevel,
  [in]      BOOL    bRefresh
);

参数

[in] szDataSource

Null-terminated 字符串，指定用于枚举性能对象的日志文件的名称。 如果 NULL，则该函数使用在 中指定的计算机

szMachineName 参数来枚举名称。

[in] szMachineName

Null-terminated 字符串，指定用于枚举性能对象的计算机的名称。

在计算机名称中包含前导斜杠，例如 \computername。

如果 szDataSource 参数 NULL，则可以将 szMachineName 设置为 NULL 以指定本地计算机。

[out] mszObjectList

接收对象名称列表的调用方分配的缓冲区。 此列表中的每个对象名称都由 null 字符终止。 该列表以两个 null-terminateor 字符终止。 如果 pcchBufferLength 参数为零，则设置为 NULL。

[in, out] pcchBufferSize

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

Windows XP：向所需的缓冲区大小添加一个。

[in] dwDetailLevel

要返回的性能项的详细信息级别。 将返回属于指定详细信息级别或更少级别的所有项（级别按递增顺序列出）。 此参数可以是下列值之一。

价值 意义
PERF_DETAIL_NOVICE
 新手用户的详细信息级别。
PERF_DETAIL_ADVANCED
 高级用户详细信息级别。
PERF_DETAIL_EXPERT
 专家用户详细信息级别。
PERF_DETAIL_WIZARD
 系统设计器的详细信息级别。

[in] bRefresh

指示是否应自动刷新缓存的对象列表。 指定以下值之一。

如果调用此函数两次，一次获取列表的大小，第二次获取实际列表，请将此参数设置为第一次调用时 TRUE，并在第二次调用时 FALSE。 如果两个调用都 TRUE，则第二个调用也可能返回PDH_MORE_DATA，因为对象数据可能在调用之间发生更改。

价值 意义
TRUE
 在返回对象之前，会自动刷新对象缓存。
FALSE
 不要自动刷新缓存。

返回值

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

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

返回代码 描述
PDH_MORE_DATA
 mszObjectList 缓冲区太小，无法保存对象列表。 如果输入时 pcchBufferLength 为零，则预期返回值。 如果输入上的指定大小大于零，但小于所需大小，则不应依赖返回的大小来重新分配缓冲区。
PDH_CSTATUS_NO_MACHINE
 指定的计算机处于脱机状态或不可用。
PDH_CSTATUS_NO_OBJECT
 找不到指定的对象。
PDH_INVALID_ARGUMENT
 参数无效。 例如，在某些版本中，如果输入上的指定大小大于零但小于所需大小，则可能会收到此错误。

言论

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

注意

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

要求

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

另请参阅

PdhEnumObjectItems

PdhEnumObjectsH