Méthode IPropertyDescription ::GetRelativeDescription (propsys.h)

  • Article

Compare deux valeurs de propriété de la manière spécifiée par la description de la propriété. Retourne deux chaînes d’affichage qui décrivent la façon dont les deux propriétés se comparent.

Syntaxe

HRESULT GetRelativeDescription(
  [in]  REFPROPVARIANT propvar1,
  [in]  REFPROPVARIANT propvar2,
  [out] LPWSTR         *ppszDesc1,
  [out] LPWSTR         *ppszDesc2
);

Paramètres

[in] propvar1

Type : REFPROPVARIANT

Référence à une structure PROPVARIANT qui contient le type et la valeur de la première propriété.

[in] propvar2

Type : REFPROPVARIANT

Référence à une structure PROPVARIANT qui contient le type et la valeur de la deuxième propriété.

[out] ppszDesc1

Type : LPWSTR*

Lorsque cette méthode retourne, contient l’adresse d’un pointeur vers la chaîne de description qui compare la première propriété à la deuxième propriété. La chaîne est terminée par null.

[out] ppszDesc2

Type : LPWSTR*

Lorsque cette méthode retourne, contient l’adresse d’un pointeur vers la chaîne de description qui compare la deuxième propriété à la première propriété. La chaîne est terminée par null.

Valeur retournée

Type : HRESULT

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

Remarques

Cette méthode est influencée par l’attribut relativeDescriptionType de l’élément displayInfo dans le fichier .propdesc de la propriété.

Il incombe à l’application appelante de libérer ppszDesc1 et ppszDesc2 via CoTaskMemFree lorsqu’ils ne sont plus nécessaires.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau uniquement]
Plateforme cible Windows
En-tête propsys.h

Voir aussi

IPropertyDescription

Schéma de description de propriété