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.
GpiQueryCurrentPosition (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIPRIMITIVES
 
BOOL GpiQueryCurrentPosition(hps, pptl)
HPS hps;         /* presentation-space handle                 */
PPOINTL pptl;    /* address of structure for current position */
 
The GpiQueryCurrentPosition function returns the value of the current
position. The function cannot be used in an open segment when the drawing
mode is DM_RETAIN.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
pptl       Points to a POINTL structure that receives the current position.
 
Return Value
 
The return value is GPI_OK if the function is successful or GPI_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_INV_IN_RETAIN_MODE
     PMERR_PS_BUSY
 
See Also
 
GpiMove, GpiSetCurrentPosition, POINTL
 
                                      ♦