ImageList_Draw info  Overview  Group

The ImageList_Draw function draws an image list item in the specified device context.

BOOL ImageList_Draw(

HIMAGELIST himl,	// handle to the image list
int i,	// index of the image to draw
HDC hdcDst,	// handle to the destination device context
int x,	// x-coordinate to draw at
int y,	// y-coordinate to draw at
UINT fStyle	// drawing style
);

Parameters

himl

Handle to the image list.

i

Specifies the index of the image to draw.

hdcDst

Handle to the destination device context.

x 

Specifies the x-coordinate at which to draw within the specified device context.

y

Specifies the y-coordinate at which to draw within the specified device context.

fStyle

Specifies the drawing style and, optionally, the overlay image. For information about specifying an overlay image index, see the following Remarks section. This parameter can be a combination of an overlay image index and one or more of the following values.

Value	Meaning
ILD_BLEND25, ILD_FOCUS	Draws the image, blending 25 percent with the system highlight color. This value has no effect if the image list does not contain a mask.
ILD_BLEND50, ILD_SELECTED, ILD_BLEND	Draws the image, blending 50 percent with the system highlight color. This value has no effect if the image list does not contain a mask.
ILD_MASK	Draws the mask.
ILD_NORMAL	Draws the image using the background color for the image list. If the background color is the CLR_NONE value, the image is drawn transparently using the mask.
ILD_TRANSPARENT	Draws the image transparently using the mask, regardless of the background color. This value has no effect if the image list does not contain a mask.

Remarks

An overlay image is drawn transparently over the primary image specified in the i parameter. To specify an overlay image in the fStyle parameter, use the INDEXTOOVERLAYMASK macro to shift the one-based index of the overlay image. Use the OR operator to logically combine the return value of the macro with the drawing style flags specified in the fStyle parameter. You must first specify this image as an overlay image by using the ImageList_SetOverlayImage function.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

See Also

ImageList_SetOverlayImage, INDEXTOOVERLAYMASK