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 GpiQueryClipBox(hps, prcl)
HPS hps;        /* presentation-space handle         */
PRECTL prcl;    /* address of structure for clip box */
 
The GpiQueryClipBox function retrieves the world coordinates of the smallest
rectangle that encloses the intersection of the current graphics field,
viewing limit, clip path, clip region, and visible region (if any). If the
clip box is empty, the function sets the left and right sides of the
rectangle to equal values.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
prcl       Points to the RECTL structure that receives the coordinates of
           the clip box.
 
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_PS_BUSY
 
See Also
 
GpiQueryClipRegion, GpiQueryGraphicsField, GpiQueryRegionBox,
GpiQueryViewingLimits, RECTL
 
                                      ♦