Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Function Group►  ◄Overview►                          ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIREGIONS
 
LONG GpiExcludeClipRectangle(hps, prcl)
HPS hps;        /* presentation-space handle                      */
PRECTL prcl;    /* address of structure for rectangle coordinates */
 
The GpiExcludeClipRectangle function excludes a rectangle from the clip
region. The function excludes all points in the rectangle except points on
the top and right boundary.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
prcl       Points to a RECTL structure containing the rectangle.
 
Return Value
 
The return value is RGN_COMPLEX, RGN_NULL, or RGN_RECT if the function is
successful or RGN_ERROR if an error occurred.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_INV_COORDINATE
     PMERR_INV_HPS
     PMERR_INV_RECT
     PMERR_PS_BUSY
 
See Also
 
GpiIntersectClipRectangle, WinExcludeUpdateRegion, RECTL
 
                                      ♦