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.
GpiPtVisible (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIPRIMITIVES
 
LONG GpiPtVisible(hps, pptl)
HPS hps;         /* presentation-space handle      */
PPOINTL pptl;    /* address of structure for point */
 
The GpiPtVisible function checks whether a point is visible on the device
associated with the specified presentation space. A point 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 a presentation space.
 
pptl       Points to a POINTL data structure that contains the coordinates
           of the point.
 
Return Value
 
The return value is PVIS_VISIBLE or PVIS_INVISIBLE if the function is
successful or PVIS_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_PS_BUSY
 
See Also
 
GpiConvert, GpiQueryPel, POINTL