Share via

ImageList_Add (Compact 2013)

  • Article

3/28/2014

This function adds an image or images to an image list.

Syntax

int WINAPI ImageList_Add(
  HIMAGELIST himl, 
  HBITMAP hbmImage, 
  HBITMAP hbmMask 
);

Parameters

  • himl
    [in] Handle to the image list.

  • hbmImage
    [in] Handle to the bitmap that contains the image or images. The number of images is inferred from the width of the bitmap.

    hbmImage can be a handle to either a device-independent bitmap (DIB) or a device-dependent bitmap (DDB) bitmap.

  • hbmMask
    [in] Handle to the bitmap that contains the mask. If no mask is used with the image list, this parameter is ignored.

Return Value

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

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.

Requirements

Header

commctrl.h

Library

commctrl.lib,
Imgctl.lib

See Also

Reference

Image List Functions
CreateBitmap
CreateDIBSection
DeleteObject
ImageList_Create
ImageList_Remove