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
程式庫	Propsys.lib
Dll	Propsys.dll (6.0 版或更新版本)
可轉散發套件	Windows 桌面搜尋 (WDS) 3.0

另請參閱

IPropertyDescription：：GetPropertyKey

PSGetNameFromPropertyKey

PSGetPropertyDescription

PSPropertyKeyFromString