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.
GpiMarker (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIPRIMITIVES
 
LONG GpiMarker(hps, pptl)
HPS hps;         /* presentation-space handle                */
PPOINTL pptl;    /* address of structure for marker position */
 
The GpiMarker function draws a marker, placing the center of the marker at
the point specified by the pptl parameter. The current marker set and marker
symbol attributes specify the marker to draw.
 
The function moves the current position to the specified point.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
pptl       Points to a POINTL structure that contains the position of the
           marker.
 
Return Value
 
The return value is GPI_OK or GPI_HITS if the function is successful (it is
GPI_HITS if the detectable attribute is set for the presentation space and a
correlation hit occurs). The return value is GPI_ERROR if an error occurs.
 
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
 
Example
 
This example uses the GpiMarker function to draw a marker at the point
(10,10).
 
POINTL ptl = { 10, 10 };
 
GpiMarker(hps, &ptl);
 
See Also
 
GpiMove, GpiPolyMarker, GpiSetAttrs, GpiSetCurrentPosition, GpiSetMarkerBox,
GpiSetMarkerSet, POINTL