IMAPISession::GetMsgStoresTable

Article
05/31/2022

Applies to: Outlook 2013 | Outlook 2016

Provides access to the message store table that contains information about all the message stores in the session profile.

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

Parameters

ulFlags

[in] A bitmask of flags that determines the format for columns that are character strings. The following flag can be set:

MAPI_UNICODE

The string columns are in Unicode format. If the MAPI_UNICODE flag is not set, the string columns are in ANSI format.

lppTable

[out] A pointer to a pointer to the message store table.

Return value

S_OK

The table was successfully returned.

MAPI_E_BAD_CHARWIDTH

The MAPI_UNICODE flag was set and the session does not support Unicode.

Remarks

The IMAPISession::GetMsgStoresTable method retrieves a pointer to the message store table, a table maintained by MAPI that contains information about each open message store in the profile.

For a complete list of required and optional columns in the message store table, see Message Store Tables.

Notes to callers

Because MAPI updates the message store table during the session whenever changes occur, call the Advise method of the message store table to register to be notified of these changes. Possible changes include the addition of new message stores, removal of existing stores, and changes to the default store.

Setting the MAPI_UNICODE flag in the ulFlags parameter affects the format of the columns returned from the IMAPITable::QueryColumns and IMAPITable::QueryRows methods. This flag also controls the property types in the sort order returned by the IMAPITable::QuerySortOrder method.

MFCMAPI reference

For MFCMAPI sample code, see the following table.

File	Function	Comment
MainDlg.cpp	CMainDlg::OnOpenMessageStoreTable	MFCMAPI uses the IMAPISession::GetMsgStoresTable method to obtain the message store table so that it can be rendered in the main dialog box of MFCMAPI.