CLIPOBJ_bEnum (Compact 2013)

3/26/2014

This function enumerates a batch of rectangles from a specified clip region. A prior call to the CLIPOBJ_cEnumStart determines the order of enumeration.

Syntax

BOOL CLIPOBJ_bEnum(
  CLIPOBJ* pco,
  ULONG cj,
  ULONG* pv
);

Parameters

• pco
  [in] Pointer to a CLIPOBJ structure that describes the clip region to enumerate.

• cj
  [in] Size, in bytes, of the buffer pointed to by the pv parameter.

• pv
  [out] Pointer to a buffer that receives data about the clip region in an ENUMRECTS structure.

Return Value

This function returns TRUE if the driver must call this function again for more enumeration data. This function returns FALSE if the enumeration is complete.

If the CLIPOBJ_bEnum function returns TRUE with a count of zero clipping rectangles, the driver should call the CLIPOBJ_bEnum function again without taking any action.

For a user-mode printer driver, this function can return DDI_ERROR.

Remarks

The following code example shows a loop structure for calling this function:

do
{
  bMore = CLIPOBJ_bEnum(pco, sizeof(buffer), &buffer.c);
  for (i = 0; i < buffer.c; i++) 
  {
    .
    .
    .
  }
} while (bMore);

This code example writes to the buffer a count of the objects written to the buffer.

Requirements

See Also

Reference

GDI Functions for Display Drivers
CLIPOBJ_cEnumStart