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.
GpiQueryPickApertureSize (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPICORRELATION
 
BOOL GpiQueryPickApertureSize(hps, psizl)
HPS hps;         /* presentation-space handle                   */
PSIZEL psizl;    /* address of structure for pick-aperture size */
 
The GpiQueryPickApertureSize function retrieves the width and height of the
pick aperture. The pick aperture is set using the GpiSetPickApertureSize
function.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
psizl      Points to a SIZEL structure that receives the pick-aperture
           size.
 
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_HPS
     PMERR_PS_BUSY
 
See Also
 
GpiQueryPickAperturePosition, GpiSetPickApertureSize, SIZEL