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.
GpiSetPickAperturePosition (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPICORRELATION
 
BOOL GpiSetPickAperturePosition(hps, pptlPick)
HPS hps;             /* presentation-space handle                         */
PPOINTL pptlPick;    /* address of structure with center of pick aperture */
 
The GpiSetPickAperturePosition function sets the center of the pick
aperture, in presentation-page space, for subsequent non-retained
correlation operations.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
pptlPick   Points to the POINTL structure that contains the center of the
           pick aperture.
 
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
the following:
 
     PMERR_INV_COORDINATE
     PMERR_INV_HPS
     PMERR_INV_PICK_APERTURE_POSN
     PMERR_PS_BUSY
 
See Also
 
GpiQueryPickAperturePosition, GpiSetPickApertureSize, POINTL