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

Статья
03/09/2024

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

Синтаксис

PSSTDAPI PSSetPropertyValue(
  [in] IPropertyStore       *pps,
  [in] IPropertyDescription *ppd,
  [in] REFPROPVARIANT       propvar
);

Параметры

[in] pps

Тип: IPropertyStore*

Указатель на экземпляр интерфейса IPropertyStore , который представляет хранилище свойств, содержащее свойство .

[in] ppd

Тип: IPropertyDescription*

Указатель на экземпляр интерфейса IPropertyDescription , который идентифицирует отдельное свойство.

[in] propvar

Тип: REFPROPVARIANT

Ссылка на структуру PROPVARIANT , содержащую новое значение.

Возвращаемое значение

Тип: HRESULT

Если эта функция выполняется успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Эта вспомогательная функция используется для записи значения свойства в хранилище. Если вызывающий код уже имеет структуру PROPERTYKEY , может быть проще вызвать IPropertyStore::SetValue напрямую.

Примеры

В следующем примере, который будет включен в состав более крупной программы, показано, как использовать PSSetPropertyValue.

// IPropertyDescription *pPropDesc;
// IPropertyStore *pStore;
// PROPVARIANT propvar;
// Assume the variables pStore, pPropDesc, and propvar are initialized and valid.

HRESULT hr = PSSetPropertyValue(pStore, pPropDesc, propvar);

if (SUCCEEDED(hr))
{
    // The value has been written to the store but has not been committed yet.
}

Требования

Требование	Значение
Минимальная версия клиента	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

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

IPropertyStore::Commit

PSGetPropertyValue

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