DrawIconEx function (winuser.h)
Draws an icon or cursor into the specified device context, performing the specified raster operations, and stretching or compressing the icon or cursor as specified.
Syntax
BOOL DrawIconEx(
[in] HDC hdc,
[in] int xLeft,
[in] int yTop,
[in] HICON hIcon,
[in] int cxWidth,
[in] int cyWidth,
[in] UINT istepIfAniCur,
[in, optional] HBRUSH hbrFlickerFreeDraw,
[in] UINT diFlags
);
Parameters
[in] hdc
Type: HDC
A handle to the device context into which the icon or cursor will be drawn.
[in] xLeft
Type: int
The logical x-coordinate of the upper-left corner of the icon or cursor.
[in] yTop
Type: int
The logical y-coordinate of the upper-left corner of the icon or cursor.
[in] hIcon
Type: HICON
A handle to the icon or cursor to be drawn. This parameter can identify an animated cursor.
[in] cxWidth
Type: int
The logical width of the icon or cursor. If this parameter is zero and the diFlags parameter is DI_DEFAULTSIZE, the function uses the SM_CXICON system metric value to set the width. If this parameter is zero and DI_DEFAULTSIZE is not used, the function uses the actual resource width.
[in] cyWidth
Type: int
The logical height of the icon or cursor. If this parameter is zero and the diFlags parameter is DI_DEFAULTSIZE, the function uses the SM_CYICON system metric value to set the width. If this parameter is zero and DI_DEFAULTSIZE is not used, the function uses the actual resource height.
[in] istepIfAniCur
Type: UINT
The index of the frame to draw, if hIcon identifies an animated cursor. This parameter is ignored if hIcon does not identify an animated cursor.
[in, optional] hbrFlickerFreeDraw
Type: HBRUSH
A handle to a brush that the system uses for flicker-free drawing. If hbrFlickerFreeDraw is a valid brush handle, the system creates an offscreen bitmap using the specified brush for the background color, draws the icon or cursor into the bitmap, and then copies the bitmap into the device context identified by hdc. If hbrFlickerFreeDraw is NULL, the system draws the icon or cursor directly into the device context.
[in] diFlags
Type: UINT
The drawing flags. This parameter can be one of the following values.
Return value
Type: BOOL
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
Remarks
The DrawIconEx function places the icon's upper-left corner at the location specified by the xLeft and yTop parameters. The location is subject to the current mapping mode of the device context.
If only one of the DI_IMAGE and DI_MASK flags is set, then the corresponding bitmap is drawn with the SRCCOPY raster operation code.
If both the DI_IMAGE and DI_MASK flags are set:
- If the icon or cursor is a 32-bit alpha-blended icon or cursor, then the image is drawn with AC_SRC_OVER blend function and the mask is ignored.
- For all other icons or cursors, the mask is drawn with the SRCAND raster operation code, and the image is drawn with the SRCINVERT raster operation code
To duplicate DrawIcon (hDC, X, Y, hIcon), call DrawIconEx as follows:
DrawIconEx (hDC, X, Y, hIcon, 0, 0, 0, NULL, DI_NORMAL | DI_COMPAT | DI_DEFAULTSIZE);
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | winuser.h (include Windows.h) |
| Library | User32.lib |
| DLL | User32.dll |
| API set | ext-ms-win-ntuser-gui-l1-1-0 (introduced in Windows 8) |
See also
Conceptual
Reference