Header_SetHotDivider macro (commctrl.h)

Changes the color of a divider between header items to indicate the destination of an external drag-and-drop operation. You can use this macro or send the HDM_SETHOTDIVIDER message explicitly.

Syntax

int Header_SetHotDivider(
   HWND  hwnd,
   BOOL  fPos,
   DWORD dw
);

Parameters

hwnd

Type: HWND

A handle to a header control.

fPos

Type: BOOL

A value specifying how dw is to be interpreted. The value in this field can be one of the following:

Value Meaning
TRUE
Indicates that dw holds client coordinates of the pointer.
FALSE
Indicates that dw holds a divider index value.

dw

Type: DWORD

The value held here is interpreted depending on the value of fPos.

If fPos is TRUE, dw represents the x- and y- client coordinates of the pointer. The x-coordinate is in the low word, and the y-coordinate is in the high word. Upon receiving the message, the header control highlights the appropriate divider based on the dw coordinates.

If fPos is FALSE, dw represents the integer index of the divider that will be highlighted.

Return value

Type: int

Returns the index of the divider that the control highlighted.

Remarks

A header control set to the HDS_DRAGDROP style produces this effect automatically. This message is intended to be used when the owner of the control handles drag-and-drop operations manually.

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