Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CLIPOBJ_bEnum function

The CLIPOBJ_bEnum function enumerates a batch of rectangles from a specified clip region; a prior call to CLIPOBJ_cEnumStart determines the order of enumeration.

Syntax


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

Parameters

pco [in]

Pointer to a CLIPOBJ structure describing the clip region that is to be enumerated.

cj [in]

Specifies the size, in bytes, of the buffer pointed to by pv.

pv [out]

Pointer to the buffer that will receive data about the clip region in an ENUMRECTS structure.

Return value

The return value is TRUE if the driver must call this function again for more enumeration data, or FALSE if the enumeration is complete. It is possible for CLIPOBJ_bEnum to return TRUE with the number of clipping rectangles equal to zero. In such cases, the driver should call CLIPOBJ_bEnum again without taking any action.

Remarks

A possible loop structure for calling this function follows:


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

The count of objects written to the buffer is written to the buffer itself.

Requirements

Target platform

Universal

Version

Available in Windows 2000 and later versions of the Windows operating systems.

Header

Winddi.h (include Winddi.h)

Library

Win32k.lib

DLL

Win32k.sys

See also

CLIPOBJ
CLIPOBJ_cEnumStart
ENUMRECTS

 

 

Send comments about this topic to Microsoft

Show: