TreeView_CreateDragImage macro (commctrl.h)

Article
10/23/2024

Creates a dragging bitmap for the specified item in a tree-view control. The macro also creates an image list for the bitmap and adds the bitmap to the image list. An application can display the image when dragging the item by using the image list functions. You can use this macro or send the TVM_CREATEDRAGIMAGE message explicitly.

Syntax

HIMAGELIST TreeView_CreateDragImage(
   HWND      hwnd,
   HTREEITEM hitem
);

Parameters

hwnd

Type: HWND

Handle to the tree-view control.

hitem

Type: HTREEITEM

Handle to the item that receives the new dragging bitmap.

Return value

Type: HIMAGELIST

Returns the handle to the image list to which the dragging bitmap was added if successful, or NULL otherwise.

Remarks

If you create a tree-view control without an associated image list, you cannot use the TreeView_CreateDragImage macro to create the image to display during a drag operation. You must implement your own method of creating a drag cursor.

Your application is responsible for destroying the image list when it is no longer needed.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	commctrl.h

Share via