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.
_GetBkColor Function
◄Summary► ◄Details► ◄Example► ◄Back►
Returns
LongInt Current background color
Description
The _GetBkColor function returns the current background color.
In a text mode (such as _TextC80), the _SetBkColor function
accepts and _GetBkColor returns a color index. For example,
_SetBkColor( 2 ) sets the background color to color index 2. The
actual color displayed depends on the palette mapping for color
index 2. The default color value for color index 2 is green in a
color text mode.
In a color graphics mode (such as _ERESCOLOR), _SetBkColor
accepts and _GetBkColor returns a color value (as used in the
_RemapPalette procedure). The value for the background color can
be given by the color constants defined in MSGraph. For example,
_SetBkColor( _Green ) sets the background color in a graphics mode
to green. These constants are provided for convenience in
working with the most common colors. The actual range of colors
available is generally much greater.
When a color argument is of type LongInt, it generally refers to a
color value, and when it is of type Integer, it refers to an
attribute or color index. _SetBkColor and _GetBkColor are
exceptions; the argument is a color index in text modes and
a color value in graphics modes. A more complete discussion of
colors is given in the description of the _RemapPalette function.