ImageList_AddIcon (Compact 2013)

3/28/2014

This macro adds an icon to an image list. ImageList_AddIcon calls the ImageList_ReplaceIcon function.

Syntax

int WINAPI ImageList_AddIcon( 
  HIMAGELIST himl, 
  HICON hicon 
);

Parameters

• himl
  Handle to the image list. If this parameter identifies a masked image list, the macro copies both the image and mask bitmaps of the icon or cursor. If this parameter identifies a nonmasked image list, the macro copies only the image bitmap.

• hicon
  Handle to the icon or cursor that contains the bitmap and mask for the new image.

Return Value

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

Remarks

In Windows Embedded Compact, you can only use this macro with icons, not cursors.

Because the system does not save hicon, you can destroy it after the macro returns if the icon was created by the CreateIcon function. You do not need to destroy hicon if it was loaded by the LoadIcon function; the system automatically frees an icon resource when it is no longer needed.

The ImageList_AddIcon macro is defined as follows.

#define ImageList_AddIcon(himl, hicon) ImageList_ReplaceIcon(himl, -1, hicon)

Requirements

See Also

Reference

Image List Macros
ImageList_Create
ImageList_ReplaceIcon
LoadIcon