ImageList_Remove info  Overview  Group

The ImageList_Remove function removes an image from an image list.

BOOL ImageList_Remove(

HIMAGELIST himl,
int i
);

// Related macro 

BOOL ImageList_RemoveAll(himl); 

 

Parameters

himl 

Handle to the image list.

i

Index of the image to remove. If the i parameter is - 1, the function removes all images.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks

When an image is removed, the indexes of the remaining images are adjusted such 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, if any, becomes image 0, image 2 becomes image 1, and so on.