PSGetPropertyDescription 函式 (propsys.h)

  • 發行項

取得 PROPERTYKEY 結構所指定屬性的屬性描述介面實例。

語法

PSSTDAPI PSGetPropertyDescription(
  [in]  REFPROPERTYKEY propkey,
  [in]  REFIID         riid,
  [out] void           **ppv
);

參數

[in] propkey

類型： REFPROPERTYKEY

PROPERTYKEY 的參考。

[in] riid

類型： REFIID

所要求介面之介面標識碼的參考。

[out] ppv

類型： void**

當此函式傳回時，包含 riid中要求的介面指標。 這通常是 IPropertyDescription、IPropertyDescriptionAliasInfo 或 IPropertyDescriptionSearchInfo。

傳回值

類型： PSSTDAPI

傳回下列其中一個值。

傳回碼 描述
S_OK
 已取得介面。
E_INVALIDARG
 ppv 參數為 NULL。
TYPE_E_ELEMENTNOTFOUND
 PROPERTYKEY 不存在於架構子系統快取中。

備註

建議您使用在 Objbase.h 中定義的 IID_PPV_ARGS 宏來封裝 riid 和 ppv 參數。 此宏會根據 ppv 中值所指向的介面提供正確的 IID，這可消除編碼錯誤的可能性。

範例

下列範例要包含在較大的程式中，示範如何使用 PSGetPropertyDescription 來取得 ratings 屬性的屬性描述。

IPropertyDescription *pPropDesc;

HRESULT hr = PSGetPropertyDescription(PKEY_Ratings, IID_PPV_ARGS(&pPropDesc));

if (SUCCEEDED(hr))
{
    // pPropDesc is now valid.
 
    pPropDesc->Release();
}

規格需求

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

另請參閱

PSGetPropertyDescriptionByName

PSGetPropertySystem