Export (0) Print
Expand All

SetBkColor function

The SetBkColor function sets the current background color to the specified color value, or to the nearest physical color if the device cannot represent the specified color value.

Syntax


COLORREF SetBkColor(
  _In_  HDC hdc,
  _In_  COLORREF crColor
);

Parameters

hdc [in]

A handle to the device context.

crColor [in]

The new background color. To make a COLORREF value, use the RGB macro.

Return value

If the function succeeds, the return value specifies the previous background color as a COLORREF value.

If the function fails, the return value is CLR_INVALID.

Remarks

This function fills the gaps between styled lines drawn using a pen created by the CreatePen function; it does not fill the gaps between styled lines drawn using a pen created by the ExtCreatePen function. The SetBkColor function also sets the background colors for TextOut and ExtTextOut.

If the background mode is OPAQUE, the background color is used to fill gaps between styled lines, gaps between hatched lines in brushes, and character cells. The background color is also used when converting bitmaps from color to monochrome and vice versa.

Examples

For an example, see "Example of Owner-Drawn Menu Items" in Using Menus.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wingdi.h (include Windows.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

Painting and Drawing Overview
Painting and Drawing Functions
COLORREF
CreatePen
ExtCreatePen
GetBKColor
GetBkMode
SetBkMode

 

 

Community Additions

ADD
Show:
© 2014 Microsoft