MFENUMPROC callback function (wingdi.h)

Article
10/13/2021

The EnumMetaFileProc function is an application-defined callback function that processes Windows-format metafile records. This function is called by the EnumMetaFile function. The MFENUMPROC type defines a pointer to this callback function. EnumMetaFileProc is a placeholder for the application-defined function name.

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 EnhMetaFileProc.

Syntax

MFENUMPROC Mfenumproc;

int Mfenumproc(
       HDC hdc,
       HANDLETABLE *lpht,
       METARECORD *lpMR,
  [in] int nObj,
       LPARAM param
)
{...}

Parameters

hdc

lpht

lpMR

[in] nObj

Specifies the number of objects with associated handles in the handle table.

param

Return value

This function must return a nonzero value to continue enumeration; to stop enumeration, it must return zero.

Remarks

An application must register the callback function by passing its address to the EnumMetaFile function.

EnumMetaFileProc is a placeholder for the application-supplied function name.

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)