IResultData::Sort

[This is preliminary documentation and subject to change.]

Sorts all items in the result pane.

HRESULT Sort(
  int nColumn          // Index of column header clicked
  DWORD dwSortOptions  // Sort options
  long lUserParam      // User-provided information
);
 

Parameters

nColumn

[in] Index of the column header clicked.

dwSortOptions

[in] Currently there is only one option, RSI_DESCENDING, which indicates that the sort should be in descending order

lUserParam

[in] Specifies information determined by the user. This parameter can contain a variety of entries including sort order, context information, and so on.

Return Values

S_OK

The sort was successfully performed.

E_UNEXPECTED

An unexpected error occurred.

Remarks

By default, the sort is in ascending order unless RSI_DESCENDING is specified.

When applied to virtual lists, IResultData::Sort calls IResultOwnerData::SortItems instead of IResultDataCompare::Compare.

See Also

IResultData, IResultDataCompare::Compare, IResultOwnerData::SortItems