SetBkColor

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

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.

COLORREFSetBkColor
( 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 COLORREFvalue.

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 CreatePenfunction. The SetBKColorfunction also sets the background colors for the ExtTextOutfunction.

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

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Wingdi.h		Mgbase.lib

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.