ImageList_AddIcon
Collapse the table of content
Expand the table of content

ImageList_AddIcon macro

Adds an icon or cursor to an image list. ImageList_AddIcon calls the ImageList_ReplaceIcon function.

Syntax


int ImageList_AddIcon(
   HIMAGELIST himl,
   HICON      hicon
);

Parameters

himl

Type: HIMAGELIST

A 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

Type: HICON

A handle to the icon or cursor that contains the bitmap and mask for the new image.

Return value

Returns the index of the new image if successful, or -1 otherwise.

Remarks

Because the system does not save hicon, you can destroy it after the macro returns if the icon or cursor 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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Commctrl.h

 

 

Show:
© 2016 Microsoft