EnumObjectsProc callback function

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

int CALLBACK EnumObjectsProc(
  _In_ LPVOID lpLogObject,
  _In_ LPARAM lpData
);

Parameters

  • lpLogObject [in]
    A pointer to a LOGPEN or LOGBRUSH structure describing the attributes of the object.

  • lpData [in]
    A pointer to the application-defined data passed by the EnumObjects function.

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wingdi.h (include Windows.h)

See also

Device Contexts Overview

Device Context Functions

EnumObjects

GlobalAlloc

GlobalLock

LOGPEN

LOGBRUSH