Share via


Función GdiComment (wingdi.h)

La función GdiComment copia un comentario de un búfer en un metarchivo de formato mejorado especificado.

Sintaxis

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

Parámetros

[in] hdc

Identificador de un contexto de dispositivo de metarchivo mejorado.

[in] nSize

Longitud del búfer de comentarios, en bytes.

[in] lpData

Puntero al búfer que contiene el comentario.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero.

Comentarios

Un comentario puede incluir cualquier tipo de información privada, por ejemplo, el origen de una imagen y la fecha en que se creó. Un comentario debe comenzar con una firma de aplicación, seguida de los datos.

Los comentarios no deben contener datos específicos de la aplicación o específicos de la posición. Los datos específicos de la posición indican la ubicación de un registro y no deben incluirse porque un metarchivo puede insertarse dentro de otro.

Un comentario público es un comentario que comienza con el identificador de firma de comentario GDICOMMENT_IDENTIFIER. Se definen los siguientes comentarios públicos.

GDICOMMENT_WINDOWS_METAFILE El GDICOMMENT_WINDOWS_METAFILE comentario público contiene un metarchivo de formato Windows equivalente a un metarchivo de formato mejorado. Este comentario solo se escribe mediante la función SetWinMetaFileBits . El registro de comentario, si se indica, sigue el registro del metarchivo ENHMETAHEADER . El comentario tiene el siguiente formato:
 

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 El GDICOMMENT_BEGINGROUP comentario público identifica el principio de un grupo de registros de dibujo. Identifica un objeto dentro de un metarchivo mejorado. El comentario tiene el siguiente formato:
 

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 El GDICOMMENT_ENDGROUP comentario público identifica el final de un grupo de registros de dibujo. El comentario GDICOMMENT_BEGINGROUP y el comentario de GDICOMMENT_ENDGROUP deben incluirse en un par y se pueden anidar. El comentario tiene el siguiente formato:
 

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

Requisitos

Requisito Value
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado wingdi.h (incluye Windows.h)
Library Gdi32.lib
Archivo DLL Gdi32.dll

Consulte también

CreateEnhMetaFile

Funciones de metarchivo

Introducción a los metarchivos

SetWinMetaFileBits