다음을 통해 공유


CLIPOBJ_bEnum (Windows CE 5.0)

Send Feedback

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

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 Values

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

OS Versions: Windows CE 1.0 and later.
Header: Winddi.h.
Link Library: Ddi_ati_lib.lib, Ddi_flat_lib.lib, Ddi_gx_lib.lib, Ddi_mq200_lib.lib, Ddi_nop_lib.lib, Ddi_rflat_lib.lib, Ddi_rgx_lib.lib, or Ddi_tvia5_lib.lib.

See Also

GDI Functions for Display Drivers | CLIPOBJ_cEnumStart

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.