Edit

Share via

ListView_GetColumnOrderArray macro (commctrl.h)

  • Article

Gets the current left-to-right order of columns in a list-view control. You can use this macro or send the LVM_GETCOLUMNORDERARRAY message explicitly.

Syntax

BOOL ListView_GetColumnOrderArray(
   HWND hwnd,
   int  iCount,
   int  *pi
);

Parameters

hwnd

Type: HWND

A handle to a list-view control.

iCount

Type: int

The number of columns in the list-view control.

pi

Type: int*

A pointer to an array of integers that will receive the index values of the columns in the list-view control. The array must be large enough to hold iCount elements.

Return value

Type: BOOL

If successful, returns nonzero and the buffer at lpiArray receives the column index of each column in the control in the order they appear from left to right. Otherwise, the return value is zero.

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