PdhParseInstanceNameW 函数 (pdh.h)
分析实例字符串的元素。
语法
PDH_FUNCTION PdhParseInstanceNameW(
[in] LPCWSTR szInstanceString,
[out] LPWSTR szInstanceName,
[in, out] LPDWORD pcchInstanceNameLength,
[out] LPWSTR szParentName,
[in, out] LPDWORD pcchParentNameLength,
[out] LPDWORD lpIndex
);
parameters
[in] szInstanceString
以 Null 结尾的字符串,指定要解析为各个组件的实例字符串。 此字符串可包含以下格式,长度小于 MAX_PATH 个字符:
- instance
- instance#index
- parent/instance
- parent/instance#index
[out] szInstanceName
接收 以 null 结尾的实例名称的调用方分配的缓冲区。 如果 pcchInstanceNameLength 为零,则设置为 NULL。
[in, out] pcchInstanceNameLength
szInstanceName 缓冲区的大小(以 TCHAR 为单位)。 如果输入为零,则函数返回PDH_MORE_DATA并将此参数设置为所需的缓冲区大小。 如果缓冲区大于所需大小,则函数会将此参数设置为使用的实际缓冲区大小。 如果输入上的指定大小大于零但小于所需大小,则不应依赖返回的大小来重新分配缓冲区。
[out] szParentName
调用方分配的缓冲区,接收父实例的 以 null 结尾的名称(如果指定)。 如果 pcchParentNameLength 为零,则设置为 NULL。
[in, out] pcchParentNameLength
szParentName 缓冲区的大小(以 TCHAR 为单位)。 如果输入为零,则函数返回PDH_MORE_DATA并将此参数设置为所需的缓冲区大小。 如果缓冲区大于所需大小,则函数会将此参数设置为使用的实际缓冲区大小。 如果输入上的指定大小大于零但小于所需大小,则不应依赖返回的大小来重新分配缓冲区。
[out] lpIndex
实例的索引值。 如果字符串中不存在索引项,则此值为零。 此参数可以为 NULL。
返回值
如果函数成功,则返回ERROR_SUCCESS。
如果函数失败,则返回值为 系统错误代码 或 PDH 错误代码。 下面是可能的值。
返回代码 | 说明 |
---|---|
|
参数无效。 例如,在某些版本中,如果输入上的指定大小大于零但小于所需大小,则可能会收到此错误。 |
|
一个或两个字符串缓冲区太小,无法包含数据。 如果输入上的相应大小缓冲区为零,则此返回值应为预期值。 如果输入上的指定大小大于零但小于所需大小,则不应依赖返回的大小来重新分配缓冲区。 |
|
实例字符串格式不正确、长度超过 MAX_PATH 个字符或无法分析。 |
注解
应调用此函数两次,第一次获取所需的缓冲区大小 (将缓冲区大小设置为 NULL ,将缓冲区大小设置为 0) ,第二次调用以获取数据。
注意
pdh.h 标头将 PdhParseInstanceName 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定。
要求
最低受支持的客户端 | Windows XP [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2003 [仅限桌面应用] |
目标平台 | Windows |
标头 | pdh.h |
Library | Pdh.lib |
DLL | Pdh.dll |