IMAPIFolder::SaveContentsSort
Applies to: Office 2010 | Outlook 2010 | Visual Studio
Sets the default sort order for a folder's contents table.
HRESULT SaveContentsSort(
LPSSortOrderSet lpSortCriteria,
ULONG ulFlags
);
Parameters
lpSortCriteria
[in] A pointer to an SSortOrderSet structure that contains the default sort order.ulFlags
[in] A bitmask of flags that controls how the default sort order is set. The following flag can be set:- RECURSIVE_SORT
The default sort order set applies to the indicated folder and to all its subfolders.
- RECURSIVE_SORT
Return Value
S_OK
The sort order was successfully saved.MAPI_E_NO_SUPPORT
The message store provider does not support saving a sort order for its folder contents tables.
Remarks
The IMAPIFolder::SaveContentsSort method establishes a default sort order for a folder's contents table. That is, when a client calls the folder's IMAPIContainer::GetContentsTable method after the code calls SaveContentsSort, the rows in the returned contents table will appear in the order established by SaveContentsSort.
Not all message store providers support SaveContentsSort; it is acceptable for message store providers to return MAPI_E_NO_SUPPORT from the SaveContentsSort method.