Edit

Share via

ImageList_SetBkColor function (commctrl.h)

  • Article

Sets the background color for an image list. This function only works if you add an icon or use ImageList_AddMasked with a black and white bitmap. Without a mask, the entire image is drawn; hence the background color is not visible.

Syntax

COLORREF ImageList_SetBkColor(
  [in] HIMAGELIST himl,
  [in] COLORREF   clrBk
);

Parameters

[in] himl

Type: HIMAGELIST

A handle to the image list.

[in] clrBk

Type: COLORREF

The background color to set. This parameter can be the CLR_NONE value; in that case, images are drawn transparently using the mask.

Return value

Type: COLORREF

Returns the previous background color if successful, or CLR_NONE otherwise.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header commctrl.h
Library Comctl32.lib
DLL Comctl32.dll