Partager via


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

Obtient la chaîne d’affichage localisée qui décrit l’ordre de tri actuel.

Syntaxe

HRESULT GetSortDescriptionLabel(
  [in]  BOOL   fDescending,
  [out] LPWSTR *ppszDescription
);

Paramètres

[in] fDescending

Type : BOOL*

TRUE si ppszDescription doit référencer la chaîne « Z on top » ; FALSE pour référencer la chaîne « A en haut ».

[out] ppszDescription

Type : LPWSTR*

Lorsque cette méthode retourne, contient l’adresse d’un pointeur vers la description de tri sous la forme d’une chaîne Unicode 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

La chaîne récupérée par cette méthode est déterminée par les indicateurs définis dans l’attribut sortDescription de l’élément labelInfo dans le fichier .propdesc de la propriété.

Il incombe à l’application appelante de libérer ppszDescription lorsqu’il n’est plus nécessaire.

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é