SetClipList

Called by the DCI Client to tell the DCI Provider about changes to the overlap status of the window in which drawing is occurring. Support of this function is required for all OffScreen surfaces.

DCIRVAL CALLBACK _loadds SetClipList(lpSurface, lpClipList)

LPVOID	*lpSurface*;
LPRGNDATA	*lpClipList*;

INPUT PARAMETERS

lpSurface	Specifies a far pointer to a DCISURFACEINFO structure that was previously obtained via a DCIDCREATEPRIMARYSURFACE, DCICREATEOFFSCREENSURFACE, or DCICREATEOVERLAYSURFACE escape.
lpClipList	Specifies a far pointer to a RGNDATA structure in screen coordinates.

RETURNS

Returns DCI_OK on success, or an error code on failure. DCI error codes are listed in Chapter 2 of the DCI Specification.

COMMENTS

The DCI Provider will be passed a RGNDATA structure describing the visible area. The buffer field of the RGNDATA structure is in an array of rectangles. Fields within the header preceding the array define the length of the array. The walk order of the rectangles is left-to-right, top-to-bottom.

The rcBound rectangle in the RGNDATAHEADER structure specifies the visible region. It is the DCI Client's responsibility to ensure the bounding rectangle in the rcBound field of the RGNDATAHEADER structure intersects the destination rectangle in a prior SetDestination call. The very first SetClipList call must be preceded by a SetDestination call.