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 GpiPtInRegion(hps, hrgn, pptl)
HPS hps;         /* presentation-space handle      */
HRGN hrgn;       /* region handle                  */
PPOINTL pptl;    /* address of structure for point */
 
The GpiPtInRegion function checks whether a point lies in the region
specified by the hrgn parameter. The function checks the region only if the
device context containing the region is associated with the given
presentation space.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies a presentation space.
 
hrgn       Identifies a region.
 
pptl       Points to a POINTL data structure that contains the coordinates
           of the point.
 
Return Value
 
The return value is PRGN_OUTSIDE or PRGN_INSIDE if the function is
successful or PRGN_ERROR if an error occurs.
 
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_HRGN
     PMERR_PS_BUSY
 
See Also
 
GpiRectInRegion, POINTL
 
                                      ♦