Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function replaces an image with an icon.

Syntax 

int WINAPI ImageList_ReplaceIcon(
  HIMAGELIST 
himl, 
  int 
i, 
  HICON 
hicon 
);

Parameters

himl

[in] Handle to the image list.

i

[in] Index of the image to replace. If iis –1, the function appends the image to the end of the list.

hicon

[in] Handle to the icon that contains the bitmap and mask for the new image.

Return Value

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

Remarks

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

You can only use the ImageList_ReplaceIconfunction with icons, not cursors.

Requirements

Header commctrl.h
Library commctrl.lib, Imgctl.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also