GdiComment info  Overview  Group

The GdiComment function copies a comment from a buffer into a specified enhanced-format metafile.

BOOL GdiComment(

Parameters

hdc

Identifies an enhanced-metafile device context.

cbSize

Specifies the length of the comment buffer, in bytes.

lpData

Points to the buffer that contains the comment.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

A comment can include any kind of private information ¾ for example, the source of a picture and the date it was created. A comment should begin with an application signature, followed by the data.

Comments should not contain application-specific or position-specific data. Position-specific data specifies the location of a record, and it should not be included because one metafile may be embedded within another metafile.

A public comment is a comment that begins with the comment signature identifier GDICOMMENT_IDENTIFIER. The following public comments are defined:

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. 

 

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. 

DWORD   ident;       // This contains GDICOMMENT_IDENTIFIER. 

DWORD   iComment;    // This contains GDICOMMENT_ENDGROUP. 

 

DWORD   ident;          // This contains GDICOMMENT_IDENTIFIER. 

DWORD   iComment;       // This contains GDICOMMENT_MULTIFORMATS. 

RECTL   rclOutput;      // This is the bounding rectangle for the 

                        // picture in logical coordinates. 

DWORD   nFormats;       // This contains the number of formats in 

                        // the comment. 

EMRFORMAT aemrformat[1];// This is an array of EMRFORMAT structures 

                        // in the order of preference.  The data 

                        // for each format follows the last 

                        // EMRFORMAT structure. 

The EMRFORMAT structure has the following form:

typedef struct tagEMRFORMAT   { 

    DWORD   dSignature; 

    DWORD   nVersion; 

    DWORD   cbData; 

    DWORD   offData; 

} EMRFORMAT; 

 

See Also

CreateEnhMetaFile, EMRFORMAT, SetWinMetaFileBits 

  .