IMAPIFolder::SaveContentsSort

The IMAPIFolder::SaveContentsSort method sets the default sort order for a folder's contents table.

Quick Info

See IMAPIFolder : IMAPIContainer.

HRESULT SaveContentsSort(
  LPSSortOrderSet lpSortCriteria,   
  ULONG ulFlags                     
);
 

Parameters

lpSortCriteria

[in] Pointer to an SSortOrderSet structure containing the default sort order.

ulFlags

[in] 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 of its subfolders.

Return Values

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 calling 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.

See Also

IMAPIContainer::GetContentsTable, SSortOrderSet