EnumMetaFile function (wingdi.h)

Article
02/22/2024

The EnumMetaFile function enumerates the records within a Windows-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.

Note This function is provided only for compatibility with Windows-format metafiles. Enhanced-format metafiles provide superior functionality and are recommended for new applications. The corresponding function for an enhanced-format metafile is EnumEnhMetaFile.

Syntax

BOOL EnumMetaFile(
  [in] HDC        hdc,
  [in] HMETAFILE  hmf,
  [in] MFENUMPROC proc,
  [in] LPARAM     param
);

Parameters

[in] hdc

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

[in] hmf

Handle to a Windows-format metafile.

[in] proc

Pointer to an application-supplied callback function. For more information, see EnumMetaFileProc.

[in] param

Pointer to optional data.

Return value

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

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

Remarks

To convert a Windows-format metafile into an enhanced-format metafile, use the SetWinMetaFileBits function.

You can use the EnumMetaFile function to embed one Windows-format 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