IResultOwnerData::SortItems

[This is preliminary documentation and subject to change.]

Specifies the parameters the snap-in should use to sort the items.

HRESULT SortItems(
  int nColumn,            // Index of column header clicked
  DWORD dwSortOptions,    // Sort options
  long lUserParam,        // User parameter 
);
 

Parameters

nColumn

[in] Index of the column header clicked.

dwSortOptions

[in] The sort defaults to ascending order unless RSI_DESCENDING is specified, which indicates the sort should be in descending order.

lUserParam

[in] A user parameter passed in an IResultData::Sort call, NULL if user initiated sort.

Return Values

S_OK

The sort was completed successfully. MMC will redraw the list on receiving an S_OK.

S_FALSE

The sort was not completed.

Remarks

Because the snap-in maintains all the item data storage for a virtual list, the list does not support sorting. Call this function when the user clicks the header item of a virtual list or the snap-in calls IResultData::Sort.

See Also

IResultData::Sort