GetEnhMetaFileDescriptionA, fonction (wingdi.h)

La fonction GetEnhMetaFileDescription récupère une description de texte facultative à partir d’un métafichier au format amélioré et copie la chaîne dans la mémoire tampon spécifiée.

Syntaxe

UINT GetEnhMetaFileDescriptionA(
  [in]  HENHMETAFILE hemf,
  [in]  UINT         cchBuffer,
  [out] LPSTR        lpDescription
);

Paramètres

[in] hemf

Handle du métafichier amélioré.

[in] cchBuffer

Taille, en caractères, de la mémoire tampon pour recevoir les données. Seuls ces nombreux caractères seront copiés.

[out] lpDescription

Pointeur vers une mémoire tampon qui reçoit la description de texte facultative.

Valeur retournée

Si la description de texte facultative existe et que le pointeur de mémoire tampon a la valeur NULL, la valeur de retour est la longueur de la chaîne de texte, en caractères.

Si la description de texte facultative existe et que le pointeur de la mémoire tampon est un pointeur valide, la valeur de retour correspond au nombre de caractères copiés dans la mémoire tampon.

Si la description de texte facultative n’existe pas, la valeur de retour est zéro.

Si la fonction échoue, la valeur de retour est GDI_ERROR.

Remarques

La description de texte facultative contient deux chaînes : la première identifiant l’application qui a créé le métafichier amélioré et la deuxième identifiant l’image contenue dans le métafichier. Les chaînes sont séparées par un caractère null et terminées par deux caractères null, par exemple, « Éditeur graphique XYZ\0Bald Eagle\0\0 » où \0 représente le caractère null.

Lorsque les arguments de texte doivent utiliser des caractères Unicode, utilisez cette fonction comme fonction à caractères larges. Lorsque les arguments de texte doivent utiliser des caractères du jeu de caractères Windows, utilisez cette fonction comme fonction ANSI.

Notes

L’en-tête wingdi.h définit GetEnhMetaFileDescription comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	wingdi.h (inclure Windows.h)
Bibliothèque	Gdi32.lib
DLL	Gdi32.dll

Voir aussi

CreateEnhMetaFile

Fonctions de métafichier

Vue d’ensemble des métafichiers