EnumEnhMetaFile function (wingdi.h)

Article
02/22/2024

The EnumEnhMetaFile function enumerates the records within an enhanced-format metafile by retrieving each record and passing it to the specified callback function. The application-supplied callback function processes each record as required. The enumeration continues until the last record is processed or when the callback function returns zero.

Syntax

BOOL EnumEnhMetaFile(
  [in] HDC           hdc,
  [in] HENHMETAFILE  hmf,
  [in] ENHMFENUMPROC proc,
  [in] LPVOID        param,
  [in] const RECT    *lpRect
);

Parameters

[in] hdc

A handle to a device context. This handle is passed to the callback function.

[in] hmf

A handle to an enhanced metafile.

[in] proc

A pointer to the application-supplied callback function. For more information, see the EnhMetaFileProc function.

[in] param

A pointer to optional callback-function data.

[in] lpRect

A pointer to a RECT structure that specifies the coordinates, in logical units, of the picture's upper-left and lower-right corners.

Return value

If the callback function successfully enumerates all the records in the enhanced metafile, the return value is nonzero.

If the callback function does not successfully enumerate all the records in the enhanced metafile, the return value is zero.

Remarks

Points along the edge of the rectangle pointed to by the lpRect parameter are included in the picture. If the hdc parameter is NULL, the system ignores lpRect.

If the callback function calls the PlayEnhMetaFileRecord function, hdc must identify a valid device context. The system uses the device context's transformation and mapping mode to transform the picture displayed by the PlayEnhMetaFileRecord function.

You can use the EnumEnhMetaFile function to embed one enhanced-metafile within another.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wingdi.h (include Windows.h)
Library	Gdi32.lib
DLL	Gdi32.dll