Share via

ImageList_Draw (Compact 2013)

  • Article

3/28/2014

This function draws an image list item in the specified device context (DC).

Syntax

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

Parameters

  • himl
    [in] Handle to the image list.
  • i
    [in] Index of the image to draw.
  • hdcDst
    [in] Handle to the destination device context.
  • x
    [in] Specifies the x-coordinate at which to draw within the specified device context.
  • y
    [in] Specifies the y-coordinate at which to draw within the specified device context.

  • fStyle
    [in] Specifies 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

    Description

    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.

Return Value

Nonzero indicates success. Zero indicates failure.

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

Header

commctrl.h

Library

commctrl.lib,
Imgctl.lib

See Also

Reference

Image List Functions
ImageList_DrawEx
ImageList_SetOverlayImage
INDEXTOOVERLAYMASK