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.
GpiSetCurrentPosition (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIPRIMITIVES
 
BOOL GpiSetCurrentPosition(hps, pptl)
HPS hps;         /* presentation-space handle              */
PPOINTL pptl;    /* address of structure with new position */
 
The GpiSetCurrentPosition function sets the current position to the
specified point. When used in an area bracket, the function closes the
current open figure (if any) and marks the start of a new figure.
 
This function is equivalent to the GpiMove function, except that, if the
current attribute mode is AM_PRESERVE (see the GpiSetAttrMode function), the
function saves the current position before setting it to the new value. It
can be restored by using the GpiPop function.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
pptl       Points to the POINTL structure that contains the new value of 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_COORDINATE
     PMERR_INV_HPS
     PMERR_PS_BUSY
 
See Also
 
GpiMove, GpiPop, GpiQueryCurrentPosition, GpiSetAttrMode, POINTL
 
                                      ♦