Share via


GdiComment, fonction (wingdi.h)

La fonction GdiComment copie un commentaire d’une mémoire tampon dans un métafichier au format amélioré spécifié.

Syntaxe

BOOL GdiComment(
  [in] HDC        hdc,
  [in] UINT       nSize,
  [in] const BYTE *lpData
);

Paramètres

[in] hdc

Handle pour un contexte d’appareil enhanced-metafile.

[in] nSize

Longueur de la mémoire tampon de commentaires, en octets.

[in] lpData

Pointeur vers la mémoire tampon qui contient le commentaire.

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro.

Remarques

Un commentaire peut inclure n’importe quel type d’informations privées, par exemple, la source d’une image et la date à laquelle elle a été créée. Un commentaire doit commencer par une signature d’application, suivie des données.

Les commentaires ne doivent pas contenir de données spécifiques à l’application ou à la position. Les données spécifiques à la position spécifient l’emplacement d’un enregistrement et ne doivent pas être incluses, car un métafichier peut être incorporé dans un autre métafichier.

Un commentaire public est un commentaire qui commence par l’identificateur de signature de commentaire GDICOMMENT_IDENTIFIER. Les commentaires publics suivants sont définis.

GDICOMMENT_WINDOWS_METAFILE Le commentaire public GDICOMMENT_WINDOWS_METAFILE contient un métafichier au format Windows équivalent à un métafichier au format amélioré. Ce commentaire est écrit uniquement par la fonction SetWinMetaFileBits . L’enregistrement de commentaire, s’il est donné, suit l’enregistrement métafichier ENHMETAHEADER . Le commentaire se présente sous la forme suivante :
 

DWORD ident;         // This contains GDICOMMENT_IDENTIFIER.  
DWORD iComment;      // This contains GDICOMMENT_WINDOWS_METAFILE.  
DWORD nVersion;      // This contains the version number of the  
                     // Windows-format metafile.  
DWORD nChecksum;     // This is the additive DWORD checksum for  
                     // the enhanced metafile.  The checksum  
                     // for the enhanced metafile data including  
                     // this comment record must be zero.  
                     // Otherwise, the enhanced metafile has been  
                     //  modified and the Windows-format  
                     // metafile is no longer valid.  
DWORD fFlags;        // This must be zero.  
DWORD cbWinMetaFile; // This is the size, in bytes. of the  
                     // Windows-format metafile data that follows.  

GDICOMMENT_BEGINGROUP Le commentaire public GDICOMMENT_BEGINGROUP identifie le début d’un groupe d’enregistrements de dessin. Il identifie un objet dans un métafichier amélioré. Le commentaire se présente sous la forme suivante :
 

DWORD   ident;         // This contains GDICOMMENT_IDENTIFIER.  
DWORD   iComment;      // This contains GDICOMMENT_BEGINGROUP.  
RECTL   rclOutput;     // This is the bounding rectangle for the  
                       // object in logical coordinates.  
DWORD   nDescription;  // This is the number of characters in the  
                       // optional Unicode description string that  
                       // follows. This is zero if there is no  
                       // description string.  

GDICOMMENT_ENDGROUP Le commentaire public GDICOMMENT_ENDGROUP identifie la fin d’un groupe d’enregistrements de dessin. Le commentaire GDICOMMENT_BEGINGROUP et le commentaire GDICOMMENT_ENDGROUP doivent être inclus dans une paire et peuvent être imbriqués. Le commentaire se présente sous la forme suivante :
 

DWORD   ident;       // This contains GDICOMMENT_IDENTIFIER.  
DWORD   iComment;    // This contains GDICOMMENT_ENDGROUP.  

Configuration requise

Condition requise Valeur
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

SetWinMetaFileBits