ImageList_AddMasked

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library
comctl32.lib
Header File
commctrl.h
Unicode
No
Platform Notes
None

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

int ImageList_AddMasked(

HIMAGELIST himl,	// handle to the image list
HBITMAP hbmImage,	// handle to the bitmap
COLORREF crMask	// color used to generate mask
);

Parameters
himl

Handle to the image list.

hbmImage

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

crMask

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 one.

Return Values
If the function succeeds, the return value is the index of the first new image.

If the function fails, the return value is

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.