GetEnhMetaFileHeader info  Overview  Group

The GetEnhMetaFileHeader function retrieves the record containing the header for the specified enhanced-format metafile.

UINT GetEnhMetaFileHeader(

HENHMETAFILE hemf,	// handle of enhanced metafile
UINT cbBuffer,	// size of buffer, in bytes
LPENHMETAHEADER lpemh	// address of buffer to receive data
);

Parameters

hemf

Identifies the enhanced metafile for which the header is to be retrieved.

cbBuffer

Specifies the size, in bytes, of the buffer to receive the data. Only this many bytes will be copied.

lpemh

Points to an ENHMETAHEADER structure to receive the header record. If this parameter is NULL, the function returns the size of the header record.

Return Values

If the function succeeds and the structure pointer is NULL, the return value is the size of the record that contains the header; if the structure pointer is a valid pointer, the return value is the number of bytes copied. Otherwise, it is zero. To get extended error information, call GetLastError.

Remarks

An enhanced-metafile header contains such information as the metafile’s size, in bytes; the dimensions of the picture stored in the metafile; the number of records stored in the metafile; the offset to the optional text description; the size of the optional palette, and the resolution of the device on which the picture was created.

The record that contains the enhanced-metafile header is always the first record in the metafile.

Windows 95: The maximum length of the description string for an enhanced metafile is 16,384 bytes.

See Also

ENHMETAHEADER, PlayEnhMetaFile