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.

◄Function Group►  ◄Overview►                          ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPICORRELATION
 
BOOL GpiSetPickApertureSize(hps, flOption, psizlPick)
HPS hps;             /* presentation-space handle                    */
LONG flOption;       /* options                                      */
PSIZEL psizlPick;    /* address of structure with pick-aperture size */
 
The GpiSetPickApertureSize function sets the pick-aperture size. The
function sets the pick aperture to either the default value or to the size
specified by psizlPick. The default size is a rectangle in presentation-page
space that produces a square in device space that has a width and height
equal to the default-character cell height.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
flOption   Specifies the pick-aperture type. It can be one of the following
           values:
 
           Value           Meaning
           ─────────────────────────────────────────────────────────────────
           PICKAP_DEFAULT  Use default pick aperture. The psizlPick
                           parameter is ignored.
 
           PICKAP_REC      Use psizlPick value.
 
psizlPick  Points to the SIZEL structure that contains 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_INV_PICK_APERTURE_OPTION
     PMERR_INV_PICK_APERTURE_POSN
     PMERR_INV_PICK_APERTURE_SIZE
     PMERR_PS_BUSY
 
See Also
 
GpiQueryPickApertureSize, GpiSetPickAperturePosition, WinGetLastError,
SIZEL
 
                                      ♦