PSGetPropertyKeyFromName 函数 (propsys.h)

获取规范属性名称的属性键。

语法

PSSTDAPI PSGetPropertyKeyFromName(
  [in]  PCWSTR      pszName,
  [out] PROPERTYKEY *ppropkey
);

参数

[in] pszName

类型: PCWSTR

指向以 null 结尾的 Unicode 字符串的属性名称的指针。

[out] ppropkey

类型: PROPERTYKEY*

当此函数返回时,包含请求的属性键。

返回值

类型: HRESULT

返回以下值之一。

返回代码 说明
S_OK
已获取属性键结构。
E_INVALIDARG
pszName 参数为 NULL
TYPE_E_ELEMENTNOTFOUND
架构子系统缓存中不存在规范属性名称。

注解

属性键唯一标识属性。 例如,PKEY_Keywords 对应于 System.Keywords。 此函数仅对注册为属性架构一部分的属性成功。

有关函数也支持的旧属性名称的列表,请参阅 PSGetPropertyDescriptionByName

示例

以下示例将作为较大程序的一部分包含,演示如何使用 PSGetPropertyKeyFromName 获取 的属性 System.Keywords键。

PROPERTYKEY key;

HRESULT hr = PSGetPropertyKeyFromName(L"System.Keywords", &key);

if (SUCCEEDED(hr))
{
    // The property key is now valid.
}

要求

要求
最低受支持的客户端 Windows XP SP2、Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 SP1 [仅限桌面应用]
目标平台 Windows
标头 propsys.h
Library Propsys.lib
DLL Propsys.dll (版本 6.0 或更高版本)
可再发行组件 Windows 桌面搜索 (WDS) 3.0

另请参阅

IPropertyDescription::GetPropertyKey

PSGetNameFromPropertyKey

PSGetPropertyDescription

PSPropertyKeyFromString