ImageList_AddMasked

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

At a Glance

Header file: Commctrl.h
Windows CE versions: 1.0 and later

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 Values

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

Remarks

The ImageList_AddMasked function copies the bitmap to an internal data structure. Be sure to use the DeleteObject function to delete hbmImage and crMask after the function returns.

See Also

COLORREF, CreateBitmap, ImageList_Create