Fonction PSSetPropertyValue (propsys.h)

Définit la valeur d’une propriété dans un magasin de propriétés.

Syntaxe

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

Paramètres

[in] pps

Type : IPropertyStore*

Pointeur vers un instance de l’interface IPropertyStore, qui représente le magasin de propriétés qui contient la propriété.

[in] ppd

Type : IPropertyDescription*

Pointeur vers une instance de l’interface IPropertyDescription, qui identifie la propriété individuelle.

[in] propvar

Type : REFPROPVARIANT

Référence à une structure PROPVARIANT qui contient la nouvelle valeur.

Valeur retournée

Type : HRESULT

Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Cette fonction d’assistance est utilisée pour écrire une valeur de propriété dans un magasin. Si le code appelant a déjà une structure PROPERTYKEY , il peut être plus simple d’appeler IPropertyStore ::SetValue directement.

Exemples

L’exemple suivant, à inclure dans un programme plus grand, montre comment utiliser 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.
}

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP avec SP2, Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 avec SP1 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	propsys.h
Bibliothèque	Propsys.lib
DLL	Propsys.dll (version 6.0 ou ultérieure)
Composant redistribuable	Windows Desktop Search (WDS) 3.0

Voir aussi

IPropertyStore ::Commit

PSGetPropertyValue