Méthode IPropertySystem ::FormatForDisplayAlloc (propsys.h)

Article
08/25/2023

Obtient une représentation sous forme de chaîne d’une valeur de propriété dans une mémoire tampon allouée.

Syntaxe

HRESULT FormatForDisplayAlloc(
  [in]  REFPROPERTYKEY        key,
  [in]  REFPROPVARIANT        propvar,
  [in]  PROPDESC_FORMAT_FLAGS pdff,
  [out] LPWSTR                *ppszDisplay
);

Paramètres

[in] key

Type : REFPROPERTYKEY

Référence à la PROPRIÉTÉKEY souhaitée.

[in] propvar

Type : REFPROPVARIANT

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

[in] pdff

Type : PROPDESC_FORMAT_FLAGS

Format de la chaîne de propriété. Voir PROPDESC_FORMAT_FLAGS.

[out] ppszDisplay

Type : LPWSTR*

Lorsque cette méthode retourne, contient un pointeur vers la valeur mise en forme en tant que chaîne Unicode terminée par null.

Valeur retournée

Type : HRESULT

Retourne l’une des valeurs suivantes.

Code de retour	Description
S_OK	Une chaîne mise en forme est créée. Cette chaîne peut être retournée vide en raison d’une chaîne d’entrée vide ou d’une valeur non vide qui a été mise en forme en tant que chaîne vide.
S_FALSE	La chaîne mise en forme n’est pas créée. Indique que la chaîne vide est le résultat d’une VT_EMPTY.
E_OUTOFMEMORY	Indique l’échec de l’allocation.

Remarques

Vous devez initialiser le modèle COM (Component Object Model) avec CoInitialize ou OleInitialize avant d’appeler IPropertySystem ::FormatForDisplayAlloc.

En cas de réussite, cette méthode obtient une représentation de chaîne Unicode mise en forme d’une valeur de propriété pour un PROPERTYKEY spécifié et une ou plusieurs PROPDESC_FORMAT_FLAGS. Si propertyKEY n’est pas reconnu par le sous-système de schéma, IPropertySystem ::FormatForDisplayAlloc tente de mettre en forme la valeur en fonction de son VARTYPE.

Cette méthode alloue de la mémoire pour la mémoire tampon et retourne un pointeur vers celle-ci à ppszDisplay. L’application appelante doit utiliser CoTaskMemFree pour libérer la chaîne spécifiée par ppszDisplay quand elle n’est plus nécessaire.

L’objectif de cette méthode est de convertir des données en une chaîne adaptée à l’affichage pour l’utilisateur. La valeur est mise en forme en fonction des paramètres régionaux actuels, de la langue de l’utilisateur, du PROPDESC_FORMAT_FLAGS et de la description de la propriété spécifiée par la clé de propriété. Pour plus d’informations sur la façon dont le schéma de description de propriété influence la mise en forme de la valeur, consultez displayInfo, stringFormat, booleanFormat, numberFormat, NMDATETIMEFORMAT et enumeratedList. En règle générale, les PROPDESC_FORMAT_FLAGS sont utilisés pour modifier le format prescrit par la description de la propriété.

La chaîne de sortie peut contenir des caractères directionnels Unicode. Ces caractères non espacés influencent l’algorithme bidirectionnel Unicode de sorte que les valeurs apparaissent correctement lorsqu’une langue de gauche à droite (LTR) est dessinée sur une fenêtre RTL (droite à gauche), et inversement. Ces caractères sont les suivants : "\x200e", "\x200f", "\x202a", "\x202b", "\x202c", "\x202d", "\x202e".

Les propriétés suivantes utilisent des formats spéciaux et ne sont pas affectées par les PROPDESC_FORMAT_FLAGS (les exemples cités concernent les chaînes dont les paramètres régionaux actuels sont définis sur l’anglais ; généralement, la sortie est localisée, sauf indication contraire).

Propriété	Format
System.FileAttributes	Les attributs de fichier suivants sont convertis en lettres et ajoutés pour créer une chaîne (par exemple, une valeur de 0x1801 (FILE_ATTRIBUTE_READONLY \| FILE_ATTRIBUTE_COMPRESSED \| FILE_ATTRIBUTE_OFFLINE) est converti en « RCO ») : FILE_ATTRIBUTE_READONLY (0x00000001) - 'R' FILE_ATTRIBUTE_SYSTEM (0x00000004) - 'S' FILE_ATTRIBUTE_ARCHIVE (0x00000020) -'A' FILE_ATTRIBUTE_COMPRESSED (0x00000800) - 'C' FILE_ATTRIBUTE_ENCRYPTED (0x00004000) - 'E' FILE_ATTRIBUTE_OFFLINE (0x00001000) - 'O' FILE_ATTRIBUTE_NOT_CONTENT_INDEXED (0x00002000) - 'I'
System.Photo.ISOSpeed	Par exemple, « ISO-400 ».
System.Photo.ShutterSpeed	La valeur APEX est convertie en temps d’exposition à l’aide de la formule suivante : `Exposure_time = 2^(-APEX_value)` Par exemple, « 2 secondes ». ou « 1/125 s ».
System.Photo.ExposureTime	Par exemple, « 2 secondes ». ou « 1/125 s ».
System.Photo.Aperture	La valeur APEX est convertie en nombre F à l’aide de la formule suivante : `F_Number = 2^(APEX_Value / 2)` Par exemple, « f/5.6 ».
System.Photo.FNumber	Par exemple, « f/5.6 ».
System.Photo.SubjectDistance	Par exemple, « 15 m » ou « 250 mm ».
System.Photo.FocalLength	Par exemple, « 50 mm ».
System.Photo.FlashEnergy	Par exemple, « 500 bpcs ».
System.Photo.ExposureBias	Par exemple, « -2 étape », « 0 étape » ou « +3 étape ».
System.Computer.DecoratedFreeSpace	Par exemple, « 105 Mo libres de 13,2 Go ».
System.ItemType	Par exemple, « Application » ou « Image JPEG ».
System.ControlPanel.Category	Par exemple, « Apparence et personnalisation ».
System.ComputerName	Par exemple, « LITWARE05 (cet ordinateur) » ou « testbox07 ».

Si la clé de propriété ne correspond pas à une description de propriété dans l’un des schémas de propriété inscrits, cette méthode choisit un format en fonction du type de la valeur.

Type de la valeur	Format
VT_BOOLEAN	Non pris en charge.
VT_FILETIME	Chaîne de date/heure spécifiée par PROPDESC_FORMAT_FLAGS et les paramètres régionaux actuels. PDFF_SHORTTIME et PDFF_SHORTDATE sont les valeurs par défaut. Par exemple, « 13/11/2006 15 :22 ».
VARTYPE numérique	Chaîne décimale dans les paramètres régionaux actuels. Par exemple, « 42 ».
VT_LPWSTR ou autre	Converti en chaîne. Les séquences de « \r », « \t » ou « \n » sont remplacées par un espace unique.
VT_VECTOR \| Rien	Valeurs séparées par des points-virgules : un point-virgule est utilisé indépendamment des paramètres régionaux.

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
Composant redistribuable	Windows Desktop Search (WDS) 3.0

Voir aussi

IPropertySystem

Schéma de description de propriété

Partager via