ImageList_AddIcon

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

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 Values

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

Remarks

In Windows CE, 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

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

ImageList_Create, ImageList_ReplaceIcon, LoadIcon

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.