PSGetNameFromPropertyKey 函式 (propsys.h)

根據屬性 的 PROPERTYKEY，擷取屬性的正式名稱。

語法

PSSTDAPI PSGetNameFromPropertyKey(
  [in]  REFPROPERTYKEY propkey,
  [out] PWSTR          *ppszCanonicalName
);

參數

[in] propkey

類型： REFPROPERTYKEY

識別所要求屬性之 PROPERTYKEY 結構的參考。

[out] ppszCanonicalName

類型： PWSTR*

當此函式傳回時，會包含屬性名稱的指標做為 Null 終止的 Unicode 字串。

傳回值

類型： HRESULT

傳回下列其中一個值。

傳回碼	描述
S_OK	取得屬性的正式名稱。
TYPE_E_ELEMENTNOTFOUND	表示 PROPERTYKEY 不存在於架構子系統快取中。

備註

擷取指定之屬性索引鍵的正式名稱。 如同屬性索引鍵，標準名稱會唯一識別屬性。 例如， System.Keywords 是 的正式名稱 PKEY_Keywords。 此函式只會針對註冊為屬性架構一部分的屬性成功。

當不再需要時，呼叫應用程式會負責使用 CoTaskMemFree 釋放 ppszCanonicalName 所參考的字串。

範例

下列範例要包含在較大的程式中，示範如何使用 PSGetNameFromPropertyKey 從串行化屬性記憶體讀取值。

PWSTR pszName;

HRESULT hr = PSGetNameFromPropertyKey(PKEY_Keywords, &pszName);

if (SUCCEEDED(hr))
{
    // pszName now contains L"System.Keywords"
 
    CoTaskMemFree(pszName);
}

規格需求

需求	值
最低支援的用戶端	Windows XP 搭配 SP2、Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 SP1 [僅限傳統型應用程式]
目標平台	Windows
標頭	propsys.h
程式庫	Propsys.lib
Dll	Propsys.dll (6.0 版或更新版本)
可轉散發套件	Windows 桌面搜尋 (WDS) 3.0

另請參閱

IPropertyDescription：：GetCanonicalName

PSGetPropertyDescriptionByName

PSGetPropertyKeyFromName

PSStringFromPropertyKey