gpi12.hlp (Table of Contents; Topic list)
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.
GpiIntersectClipRectangle (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIREGIONS
 
LONG GpiIntersectClipRectangle(hps, prcl)
HPS hps;        /* presentation-space handle                      */
PRECTL prcl;    /* address of structure for rectangle coordinates */
 
The GpiIntersectClipRectangle function sets the new clip region (in device
coordinates) to the intersection of the current clip region and the
specified rectangle.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
prcl       Points to a RECTL structure.
 
Return Value
 
The return value is RGN_NULL, RGN_RECT, or RGN_COMPLEX 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
 
GpiExcludeClipRectangle, RECTL