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.
GpiQueryClipRegion (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIREGIONS
 
HRGN GpiQueryClipRegion(hps)
HPS hps;    /* presentation-space handle */
 
The GpiQueryClipRegion function retrieves the handle of the currently
selected clip region.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
Return Value
 
The return value is the handle of the clip region, if one is selected, or
NULL if no clip region is selected. The return value is HRGN_ERROR if an
error occurred.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_INV_HPS
     PMERR_PS_BUSY
 
See Also
 
GpiQueryClipBox, GpiQueryGraphicsField, GpiQueryViewingLimits,
GpiSetClipRegion