Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function begins dragging an image.

Syntax 

BOOL WINAPI ImageList_BeginDrag(
  HIMAGELIST 
himlTrack, 
  int 
iTrack, 
  int 
dxHotspot, 
  int 
dyHotspot 
);

Parameters

himlTrack

[in] Handle to the image list.

iTrack

[in] Index of the image to drag.

dxHotspotand dyHotspot

[in] Specifies the location of the drag position relative to the upper-left corner of the image.

Return Value

Nonzero indicates success. Zero indicates failure.

Remarks

This function creates a temporary image list that is used for dragging. In response to subsequent WM_MOUSEMOVE messages, you can move the drag image by using the ImageList_DragMovefunction. To end the drag operation, you can use the ImageList_EndDragfunction.

Requirements

Header commctrl.h
Library commctrl.lib, Imgctl.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also