Edit

Share via

Header_OrderToIndex macro (commctrl.h)

  • Article

Retrieves an index value for an item based on its order in the header control. You can use this macro or send the HDM_ORDERTOINDEX message explicitly.

Syntax

int Header_OrderToIndex(
   HWND hwnd,
   int  i
);

Parameters

hwnd

Type: HWND

A handle to a header control.

i

Type: int

The order that the item appears within the header control, from left to right. The index value of the item in the far left column would be 0, the next item to the right would be 1, and so on.

Return value

Type: int

Returns an int that specifies the index of the item. If i is invalid (negative or too large), the return equals i.

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