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
 
LONG GpiQueryBackColor(hps)
HPS hps;    /* presentation-space handle */
 
The GpiQueryBackColor function retrieves the current value of the character
background-color attribute, as set by the GpiSetBackColor function. The
function cannot be used in an open segment when the drawing mode is
DM_RETAIN.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
Return Value
 
The return value is the background color if the function is successful or
CLR_ERROR if an error occurred.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_INV_BACKGROUND_COL_ATTR
     PMERR_INV_HPS
     PMERR_PS_BUSY
 
See Also
 
GpiQueryBackMix, GpiQueryColor, GpiSetBackColor
 
                                      ♦