ImageList_SetOverlayImage
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.
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 Values
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
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_Draw, ImageList_DrawEx
Last updated on Tuesday, July 13, 2004
© 1992-2000 Microsoft Corporation. All rights reserved.