Share via

LVM_SORTITEMS (Compact 2013)

  • Article

3/28/2014

This message sorts list-view items using an application-defined comparison function. The index of each item changes to reflect the new sequence. You can send this message explicitly or by using the ListView_SortItems macro.

Syntax

LVM_SORTITEMS wParam = (WPARAM)(LPARAM) lParamSort; 
    lParam = (LPARAM)(PFNLVCOMPARE) pfnCompare;

Parameters

  • lParamSort
    Application-defined value passed to the comparison function.
  • 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.

Return Value

TRUE indicates success. FALSE indicates failure.

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 specified in the lParam member of the items' LVITEM structure when they were inserted into the list. The lParamSort parameter is the same value passed to the LVM_SORTITEMS message.

Related macro ListView_SortItems

Requirements

Header

commctrl.h

See Also

Reference

List-View Controls Messages
ListView_SortItems