ImageList_SetOverlayImage (Compact 2013)

  • Article

3/28/2014

This function adds a specified image to the list of images to be used as overlay masks. An image list can have up to four overlay masks. The function assigns an overlay mask index to the specified image.

Syntax

BOOL WINAPI ImageList_SetOverlayImage(
  HIMAGELIST himl, 
  int iImage, 
  int iOverlay 
);

Parameters

  • himl
    [in] Handle to the image list.
  • iImage
    [in] Zero-based index of an image in the himl image list. This index identifies the image to use as an overlay mask.
  • iOverlay
    [in] One-based index of the overlay mask.

Return Value

Nonzero indicates success. Zero indicates failure.

Remarks

An overlay mask is an image drawn transparently over another image. To draw an overlay mask over an image, call the ImageList_Draw or ImageList_DrawEx function. The fStyle parameter of these functions can use the INDEXTOOVERLAYMASK macro to specify an overlay mask index.

Requirements

Header

commctrl.h

Library

commctrl.lib,
Imgctl.lib

See Also

Reference

Image List Functions
ImageList_Draw
ImageList_DrawEx