SetBkColor

This function sets the current background color to the specified color. If the device cannot represent the specified color, it sets the background color to the nearest physical color.

COLORREF SetBkColor(
HDC hdc, 
COLORREF crColor
); 

Parameters

• hdc
  [in] Handle to the device context.
• crColor
  [in] Specifies the new background color.

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. 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. The SetBKColor function also sets the background colors for the ExtTextOut function.

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.

Requirements

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

CreatePen, ExtTextOut, GetBkMode, GetLastError, SetBkMode, COLORREF

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.