ImageList_Remove (Compact 2013)

  • Article

3/28/2014

This function removes an image from an image list.

Syntax

BOOL WINAPI ImageList_Remove(
  HIMAGELIST himl, 
  int i 
);

Parameters

  • himl
    [in] Handle to the image list.
  • i
    [in] Index of the image to remove. If this parameter is -1, the function removes all images.

Return Value

Nonzero indicates success. Zero indicates failure.

Remarks

When an image is removed, the indexes of the remaining images are adjusted so that the image indexes always range from zero to one less than the number of images in the image list. For example, if you remove the image at index 0, then image 1 becomes image 0, image 2 becomes image 1, and so on.

Requirements

Header

commctrl.h

Library

commctrl.lib,
Imgctl.lib

See Also

Reference

Image List Functions
ImageList_RemoveAll