ImageList_Draw function

Draws an image list item in the specified device context.

Syntax

BOOL ImageList_Draw(
   HIMAGELIST himl,
   int        i,
   HDC        hdcDst,
   int        x,
   int        y,
   UINT       fStyle
);

Parameters

himl

Type: HIMAGELIST

A handle to the image list.

i

Type: int

The zero-based index of the image to draw.

hdcDst

Type: HDC

A handle to the destination device context.

x

Type: int

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

y

Type: int

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

fStyle

Type: UINT

The drawing style and, optionally, the overlay image. For information about specifying an overlay image index, see the comments section at the end of this topic. This parameter can be a combination of an overlay image index and one or more of the following values:

Value	Meaning
ILD_BLEND
ILD_BLEND25	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	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_FOCUS
ILD_IMAGE	Set this flag if the overlay does not require a mask to be drawn. This flag causes ImageList_DrawEx to draw just the image, ignoring the 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_SELECTED
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.

 

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

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.

Requirements