ImageList_SetOverlayImage info  Overview  Group

The ImageList_SetOverlayImage 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.

BOOL ImageList_SetOverlayImage(

HIMAGELIST himl,
int iImage,
int iOverlay
);

Parameters

himl 

Handle to the image list.

iImage

Specifies the zero-based index of an image in the himl image list. This index identifies the image to use as an overlay mask.

iOverlay

Specifies the one-based index of the overlay mask. This value must be 1, 2, 3, or 4.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks

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

See Also

ImageList_Draw, ImageList_DrawEx, INDEXTOOVERLAYMASK