EnumMetaFile function (wingdi.h)

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.

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

See also

EnumEnhMetaFile

EnumMetaFileProc

Metafile Functions

Metafiles Overview

PlayMetaFile

PlayMetaFileRecord

SetWinMetaFileBits