fonction PSPropertyBag_WritePropertyKey (propsys.h)

  • Article

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

Syntaxe

PSSTDAPI PSPropertyBag_WritePropertyKey(
  [in] IPropertyBag   *propBag,
  [in] LPCWSTR        propName,
  [in] REFPROPERTYKEY value
);

Paramètres

[in] propBag

Type : IPropertyBag*

Pointeur vers un objet IPropertyBag qui représente le conteneur de propriétés dans lequel la propriété est stockée.

[in] propName

Type : LPCWSTR

Chaîne de nom de propriété terminée par null.

[in] value

Type : REFPROPERTYKEY

Structure PROPERTYKEY qui spécifie la valeur de clé de propriété à stocker dans la propriété.

Valeur retournée

Type : HRESULT

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

Remarques

Les clés de propriété identifient une propriété de manière unique. Par exemple, PKEY_Keywords correspond à System.Keywords. Cette fonction réussit uniquement pour les propriétés inscrites dans le cadre du schéma de propriété.

L’API de la fonction de propriété du conteneur de propriétés convertit entre les types de fenêtre et le type VARIANT utilisé pour exprimer des valeurs dans un conteneur de propriétés. Cela facilite l’utilisation du conteneur de propriétés, simplifie les applications et évite les erreurs de codage courantes.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 R2 [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)

Voir aussi

PSPropertyBag_ReadPropertyKey