GpiRectInRegion (1.2)
◄Function Group► ◄Overview► ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
#define INCL_GPIREGIONS
LONG GpiRectInRegion(hps, hrgn, prcl)
HPS hps; /* presentation-space handle */
HRGN hrgn; /* region handle */
PRECTL prcl; /* address of rectangle structure */
The GpiRectInRegion function checks whether any part of a rectangle lies
within the specified region. The function cannot be used if no device
context is associated with the presentation space.
Parameter Description
────────────────────────────────────────────────────────────────────────────
hps Identifies the presentation space.
hrgn Identifies the region.
prcl Points to the RECTL structure that contains the rectangle to
check.
Return Value
The return value is RRGN_OUTSIDE, RRGN_PARTIAL, or RRGN_INSIDE if the
function is successful, or RRGN_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_HRGN
PMERR_INV_RECT
PMERR_PS_BUSY
See Also
GpiPtInRegion, WinGetLastError, RECTL
♦