PSGetPropertyValue 函式 (propsys.h)
從屬性存放區取得屬性值。
語法
PSSTDAPI PSGetPropertyValue(
[in] IPropertyStore *pps,
[in] IPropertyDescription *ppd,
[out] PROPVARIANT *ppropvar
);
參數
[in] pps
類型: IPropertyStore*
IPropertyStore 介面實例的指標,代表要從中取得值的屬性存放區。
[in] ppd
類型: IPropertyDescription*
IPropertyDescription 介面實例的指標,代表屬性存放區中的 屬性。
[out] ppropvar
類型: PROPVARIANT*
未初始化 之 PROPVARIANT 結構的指標。 當此函式傳回時,會指向要求的屬性值。
傳回值
類型: HRESULT
如果此函式成功,則會傳回 S_OK。 否則,它會傳回 HRESULT 錯誤碼。
備註
這個協助程式函式可用來從存放區讀取屬性值。 如果呼叫程式代碼已經有 PROPERTYKEY 結構,則直接呼叫 IPropertyStore::GetValue 可能會比較簡單。
範例
下列範例會示範如何使用 PSGetPropertyValue 作為較大程式的一部分。
// IPropertyDescription *pPropDesc;
// IPropertyStore *pStore;
// Assume the variables pPropDesc and pStore are initialized and valid.
PROPVARIANT propvar;
HRESULT hr = PSGetPropertyValue(pStore, pPropDesc, &propvar);
if (SUCCEEDED(hr))
{
// propvar is valid.
PropVariantClear(&propvar);
}
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP 搭配 SP2、Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 SP1 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | propsys.h |
程式庫 | Propsys.lib |
Dll | Propsys.dll (6.0 版或更新版本) |
可轉散發套件 | Windows 桌面搜尋 (WDS) 3.0 |