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.
GpiRectVisible (1.2)
Function Group                                      Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIPRIMITIVES
 
LONG GpiRectVisible(hps, prcl)
HPS hps;        /* presentation-space handle      */
PRECTL prcl;    /* address of rectangle structure */
 
The GpiRectVisible function checks whether any part of a rectangle is
visible on the device associated with the specified presentation space. A
point in the rectangle is visible if it lies within the intersection of the
current graphics field, viewing limit, clip path, clip region, and visible
region (if any).
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
prcl       Points to a RECTL structure that contains the rectangle in world
           coordinates.
 
Return Value
 
The return value is RVIS_INVISIBLE, RVIS_PARTIAL, or RVIS_VISIBLE if the
function is successful, or RVIS_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_RECT
     PMERR_PS_BUSY
 
See Also
 
GpiPtVisible, RECTL