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.
A version of this page is also available for
4/8/2010

This function adds an image or images to an image list, generating a mask from the specified bitmap.

Syntax 

int WINAPI ImageList_AddMasked(
  HIMAGELIST 
himl, 
  HBITMAP 
hbmImage, 
  COLORREF 
crMask 
);

Parameters

himl

[in] Handle to the image list.

hbmImage

[in] Handle to the bitmap that contains one or more images. The number of images is inferred from the width of the bitmap.

crMask

[in] Color used to generate the mask. Each pixel of this color in the specified bitmap is changed to black, and the corresponding bit in the mask is set to 1.

Return Value

The index of the first new image indicates success. –1 indicates failure.

Remarks

The ImageList_AddMaskedfunction copies the bitmap to an internal data structure. Be sure to use the DeleteObjectfunction to delete hbmImageand crMaskafter the function returns.

Requirements

Header commctrl.h
Library commctrl.lib, Imgctl.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also