ImageList_GetDragImage

This function retrieves the temporary image list that is used for the drag image. ImageList_GetDragImage also retrieves the current drag position and the offset of the drag image relative to the drag position.

At a Glance

Header file: Commctrl.h
Windows CE versions: 1.0 and later

Syntax

HIMAGELIST WINAPI ImageList_GetDragImage(POINT FAR* ppt, POINT FAR* pptHotspot);

Parameters

ppt

[out] Pointer to the pointer to a POINT structure that receives the current drag position. Can be NULL.

pptHotspot

[out] Pointer to the pointer to a POINT structure that receives the offset of the drag image relative to the drag position. Can be NULL.

Return Values

The handle to the image list indicates success. NULL indicates failure.

Remarks

The temporary image list is destroyed when the ImageList_EngDrag function is called. To begin a drag operation, use the ImageListBeginDrag function.