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.
GpiQueryPel (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIBITMAPS
 
LONG GpiQueryPel(hps, pptl)
HPS hps;         /* presentation-space handle                */
PPOINTL pptl;    /* address of structure with point to query */
 
The GpiQueryPel function returns the color of a pel at the specified point.
The point, given in world coordinates, must be in any of the current
clipping objects: clip path, viewing limits, graphics field, clip region, or
visible region.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
pptl       Points to the POINTL structure that contains the world
           coordinates of the point.
 
Return Value
 
The return value is the color index of the pel if the function is successful
or GPI_ALTERROR 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
     PMERR_PEL_IS_CLIPPED
 
See Also
 
GpiPtVisible, GpiSetPel, POINTL