ImageList_ReplaceIcon (Compact 2013)

  • Article

3/28/2014

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 i is -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 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.

You can only use the ImageList_ReplaceIcon function with icons, not cursors.

Requirements

Header

commctrl.h

Library

commctrl.lib,
Imgctl.lib

See Also

Reference

Image List Functions
ImageList_Replace
LoadIcon