EnumObjects

The EnumObjects function enumerates the pens or brushes available for the specified device context. This function calls the application-defined callback function once for each available object, supplying data describing that object. EnumObjects continues calling the callback function until the callback function returns zero or until all of the objects have been enumerated.

int EnumObjects(
  HDC hdc,                    // handle to device context
  int nObjectType,            // object-type identifier
  GOBJENUMPROC lpObjectFunc,  // pointer to callback function
  LPARAM lParam               // pointer to application-supplied data
);
 

Parameters

hdc

Handle to the device context.

nObjectType

Specifies the object type. This parameter can be OBJ_BRUSH or OBJ_PEN.

lpObjectFunc

The pointer to the application-defined callback function. For more information about the callback function, see the EnumObjectsProc function.

lParam

Pointer to the application-defined data. The data is passed to the callback function along with the object information.

Return Values

The return value specifies the last value returned by the callback function. Its meaning is user-defined. The return value is -1 if there are too many objects to enumerate. In this case, the callback function is not called.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in wingdi.h.
  Import Library: Use gdi32.lib.

See Also

Device Contexts Overview, Device Context Functions, EnumObjectsProc, GetObject