GOBJENUMPROC callback function (wingdi.h)

Article
02/22/2024

The EnumObjectsProc function is an application-defined callback function used with the EnumObjects function. It is used to process the object data. The GOBJENUMPROC type defines a pointer to this callback function. EnumObjectsProc is a placeholder for the application-defined function name.

Syntax

GOBJENUMPROC Gobjenumproc;

int Gobjenumproc(
  LPVOID unnamedParam1,
  LPARAM unnamedParam2
)
{...}

Parameters

unnamedParam1

unnamedParam2

Return value

To continue enumeration, the callback function must return a nonzero value. This value is user-defined.

To stop enumeration, the callback function must return zero.

Remarks

An application must register this function by passing its address to the EnumObjects function.

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)