IMAPITable::GetCollapseState
Область применения: Outlook 2013 | Outlook 2016
Возвращает данные, необходимые для перестроения текущего свернутого или развернутого состояния классифицированной таблицы.
HRESULT GetCollapseState(
ULONG ulFlags,
ULONG cbInstanceKey,
LPBYTE lpbInstanceKey,
ULONG FAR * lpcbCollapseState,
LPBYTE FAR * lppbCollapseState
);
Параметры
ulFlags
Защищены; значение должно быть равно нулю.
cbInstanceKey
[в] Количество байтов в ключе экземпляра, на который указывает параметр lpbInstanceKey .
lpbInstanceKey
[в] Указатель на свойство PR_INSTANCE_KEY (PidTagInstanceKey) строки, в которой необходимо перестроить текущее свернутое или развернутое состояние. Параметр lpbInstanceKey не может иметь значение NULL.
lpcbCollapseState
[out] Указатель на количество структур, на которые указывает параметр lppbCollapseState .
lppbCollapseState
[out] Указатель на указатель на структуры, содержащие данные, описывающие текущее табличное представление.
Возвращаемое значение
S_OK
Состояние для классифицированной таблицы успешно сохранено.
MAPI_E_BUSY
Выполняется другая операция, которая предотвращает запуск операции. Либо выполняющиеся операции должны быть разрешены к завершению, либо она должна быть остановлена.
MAPI_E_NO_SUPPORT
Таблица не поддерживает классификацию и развернутые и свернутые представления.
Замечания
Метод IMAPITable::GetCollapseState работает с методом IMAPITable::SetCollapseState для изменения представления пользователя таблицы с классификацией. GetCollapseState сохраняет данные, необходимые для использования SetCollapseState для перестроения соответствующих представлений категорий таблицы с классификацией. Поставщики услуг определяют сохраненные данные. Однако большинство поставщиков услуг, реализующих GetCollapseState , сохраняют следующее:
Ключи сортировки (стандартные столбцы и столбцы категорий).
Сведения о строке, которую представляет ключ экземпляра.
Сведения для восстановления свернутых и развернутых категорий таблицы.
Дополнительные сведения о таблицах с классификацией см. в разделе Сортировка и классификация.
Примечания для исполнителей
Сохраните текущее состояние всех узлов таблицы в параметре lppbCollapseState .
Примечания для вызывающих методов
Перед вызовом SetCollapseState всегда вызывайте Метод GetCollapseState.