Share via

ImageList_ReplaceIcon

  • Article

This function replaces an image with an icon.

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 Values

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

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Commctrl.h   Commctrl.lib, Imgctl.lib

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_Replace, LoadIcon

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.