ListView_SortItems

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library

Header File
commctrl.h
Unicode
No
Platform Notes
None

The ListView_SortItems macro uses an application-defined comparison function to sort the items of a list view control. The index of each item changes to reflect the new sequence. You can use this macro or explicitly send the LVM_SORTITEMS message.

BOOL ListView_SortItems(

HWND hwnd,
PFNLVCOMPARE pfnCompare,
LPARAM lParamSort
);

Parameters
hwnd

Handle to the list view control.

pfnCompare

Pointer to the application-defined comparison function. The comparison function is called during the sort operation each time the relative order of two list items needs to be compared.

lParamSort

Application-defined value that is passed to the comparison function.

Return Values
Returns TRUE if successful or FALSE otherwise.

Remarks
The comparison function has the following form:

int CALLBACK CompareFunc(LPARAM lParam1, LPARAM lParam2,

LPARAM lParamSort);

The lParam1 parameter is the 32-bit value associated with the first item being compared; and the lParam2 parameter is the value associated with the second item. These are the values that were specified in the lParam member of the items' LV_ITEM structure when they were inserted into the list. The lParamSort parameter is the same value passed to the LVM_SORTITEMS message.

The comparison function must return a negative value if the first item should precede the second, a positive value if the first item should follow the second, or zero if the two items are equivalent.