PATHOBJ_bEnumClipLines

BOOL PATHOBJ_bEnumClipLines(

IN PATHOBJ *ppo,

IN ULONG cj,

OUT CLIPLINE *pcl

);

PATHOBJ_bEnumClipLines enumerates clipped line segments from a given path. The enumeration must be started with PATHOBJ_vEnumStartClipLines before the driver makes this call.

Parameters

ppo

Points to the path containing the clipped line segments that are to be enumerated.

cj

Specifies the size of the output buffer, in bytes. GDI does not write beyond this point in the buffer. The value of this parameter must be large enough to hold a CLIPLINE structure with at least one RUN structured. The driver should allocate space for several RUNs.

pcl

Points to the buffer in which a CLIPLINE structure is returned. The structure contains the original unclipped control points for a line segment. (The correct pixels for the line cannot be computed without the original points.) RUNs, which describe sets of pixels along the line that are not clipped away, are written to this buffer.

If a clip region is complex, a single line segment can be broken into many RUNs. A segment is returned as many times as necessary to list all of its RUNs.

The CLIPLINE structure contains the starting and ending points of the original unclipped line and the line segments, or RUNs, of that line that are to appear on the display.

Return Value

The return value is TRUE if more line segments are to be enumerated, indicating that this service should be called again. Otherwise, it is FALSE, indicating that the returned segment is the last segment in the path.