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 结尾的字符串，指定用于枚举性能对象的日志文件的名称。 如果 为 NULL，则函数使用 中指定的计算机

用于枚举名称的 szMachineName 参数。

[in] szMachineName

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

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

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

[out] mszObjectList

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

[in, out] pcchBufferSize

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

Windowsxp： 将一个添加到所需的缓冲区大小。

[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 [仅限桌面应用]
目标平台 Windows
标头 pdh.h
Library Pdh.lib
DLL Pdh.dll

另请参阅

PdhEnumObjectItems

PdhEnumObjectsH