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 GpiQueryRegionBox(hps, hrgn, prcl)
HPS hps;        /* presentation-space handle                    */
HRGN hrgn;      /* region handle                                */
PRECTL prcl;    /* address of structure for enclosing rectangle */
 
The GpiQueryRegionBox function retrieves the dimensions of the smallest
rectangle that encloses the region identified by hrgn. If the region is
empty, the function sets the left and right coordinates and top and bottom
coordinates to equal values. 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 receives the coordinates of
           the enclosing rectangle.
 
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_HPS
     PMERR_INV_HRGN
     PMERR_PS_BUSY
 
See Also
 
GpiQueryClipBox, WinGetLastError, RECTL
 
                                      ♦