IMAPISession::GetMsgStoresTable

Статья
04/04/2023

Область применения: Outlook 2013 | Outlook 2016

Предоставляет доступ к таблице хранилища сообщений, содержащей сведения обо всех хранилищах сообщений в профиле сеанса.

HRESULT GetMsgStoresTable(
  ULONG ulFlags,
  LPMAPITABLE FAR * lppTable
);

Параметры

ulFlags

[в] Битовая маска флагов, которая определяет формат столбцов, которые являются символьными строками. Можно задать следующий флаг:

MAPI_UNICODE

Строковые столбцы имеют формат Юникода. Если флаг MAPI_UNICODE не задан, строковые столбцы имеют формат ANSI.

lppTable

[out] Указатель на указатель на таблицу хранилища сообщений.

Возвращаемое значение

S_OK

Таблица успешно возвращена.

MAPI_E_BAD_CHARWIDTH

Флаг MAPI_UNICODE установлен, и сеанс не поддерживает Юникод.

Замечания

Метод IMAPISession::GetMsgStoresTable извлекает указатель на таблицу хранилища сообщений— таблицу, поддерживаемую MAPI, которая содержит сведения о каждом открытом хранилище сообщений в профиле.

Полный список обязательных и необязательных столбцов в таблице хранилища сообщений см. в разделе Таблицы хранилища сообщений.

Примечания для вызывающих методов

Так как MAPI обновляет таблицу хранилища сообщений во время сеанса всякий раз, когда происходят изменения, вызовите метод Advise таблицы хранилища сообщений, чтобы зарегистрироваться, чтобы получать уведомления об этих изменениях. Возможные изменения включают добавление новых хранилищ сообщений, удаление существующих хранилищ и изменение хранилища по умолчанию.

Задание флага MAPI_UNICODE в параметре ulFlags влияет на формат столбцов, возвращаемых методами IMAPITable::QueryColumns и IMAPITable::QueryRows . Этот флаг также управляет типами свойств в порядке сортировки, возвращаемом методом IMAPITable::QuerySortOrder .

Справочные материалы по MFCMAPI

Пример кода MFCMAPI указан в приведенной ниже таблице.

Файл	Функция	Comment
MainDlg.cpp	CMainDlg::OnOpenMessageStoreTable	MFCMAPI использует метод IMAPISession::GetMsgStoresTable для получения таблицы хранилища сообщений, чтобы ее можно было отобразить в диалоговом окне main MFCMAPI.