windows_programming_notes.nbk: Home | Index | Next Page: SetCapture | Previous Page: SendNotifyMessage

 SetBkColor

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.

COLORREF SetBkColor(
  HDC hdc,           // handle to DC
  COLORREF crColor   // background color value
);

Parameters

hdc
[in] Handle to the device context.
crColor
[in] Specifies the new background color. To make a COLORREF value, use the RGB macro.

Return Values 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.

Windows NT/2000 or later: To get extended error information, call GetLastError.

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.

For an example, see Example of Owner-Drawn Menu Items.

Requirements

  Windows NT/2000 or later: Requires Windows NT 3.1 or later.
  Windows 95/98/Me: Requires Windows 95 or later.
  Header: Declared in Wingdi.h; include Windows.h.
  Library: Use Gdi32.lib.

windows_programming_notes.nbk: Home | Index | Next Page: SetCapture | Previous Page: SendNotifyMessage

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time