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_GPIPRIMITIVES
 
BOOL GpiQueryCharBox(hps, psizfxBox)
HPS hps;             /* presentation-space handle                   */
PSIZEF psizfxBox;    /* address of structure for character-box size */
 
The GpiQueryCharBox function retrieves the current value of the
character-box attribute, as set by the GpiSetCharBox function. This function
cannot be used in an open segment when the drawing mode is DM_RETAIN.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
psizfxBox  Points to the SIZEF structure that receives the character-box
           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
one of the following:
 
     PMERR_INV_HPS
     PMERR_INV_IN_RETAIN_MODE
     PMERR_PS_BUSY
 
See Also
 
GpiQueryAttrs, GpiQueryCharMode, GpiQueryDefCharBox, GpiSetCharBox,
GpiSetDrawingMode, SIZEF
 
                                      ♦