Функция PSGetPropertyValue (propsys.h)

Статья
08/25/2023

Возвращает значение свойства из хранилища свойств.

Синтаксис

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 с пакетом обновления 2 (SP2), Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2003 с пакетом обновления 1 (SP1) [только классические приложения]
Целевая платформа	Windows
Header	propsys.h
Библиотека	Propsys.lib
DLL	Propsys.dll (версия 6.0 или более поздняя)
Распространяемые компоненты	Windows Desktop Search (WDS) 3.0

См. также раздел

PSSetPropertyValue

Поделиться через