Gdi::SetBkColor_I

  • Article

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

static WINGDIAPI COLORREF WINAPI SetBkColor_I(
  HDC hdc,
  COLORREF crColor
);

Parameters

  • hdc
    [in] Handle to the device context.
  • crColor
    [in] COLORREF value that specifies the new background color.

Return Values

If the method 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 method is an internal version of the SetBkColor function.

This method fills the gaps between styled lines drawn using a pen created by the Gdi::CreatePen_I method. The Gdi::SetBKColor_I method also sets the background colors for the Gdi::ExtTextOutW_I method.

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

OS Versions: Windows CE .NET 4.0 and later.
Header: Gdi.hpp.

See Also

SetBkColor | Gdi::CreatePen_I | Gdi::ExtTextOutW_I | Gdi::GetBkMode_I | Gdi::SetBkMode_I | COLORREF

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.