ImageList_Add

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_Add function adds an image or images to an image list.

int ImageList_Add(

HIMAGELIST himl,	// handle to the image list
HBITMAP hbmImage,	// handle to the bitmap containing the image
HBITMAP hbmMask	// handle to the bitmap containing the mask
);

Parameters
himl

Handle to the image list.

hbmImage

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

hbmMask

Handle to the bitmap that contains the mask. If no mask is used with the image list, this parameter is ignored.

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_Add function copies the bitmap to an internal data structure. Be sure to use the DeleteObject function to delete hbmImage and hbmMask after the function returns.