IMsgStore::GetReceiveFolderTable
Applies to: Outlook 2013 | Outlook 2016
Provides access to the receive folder table, a table that includes information about all of the receive folders for the message store.
HRESULT GetReceiveFolderTable(
ULONG ulFlags,
LPMAPITABLE FAR * lppTable );
Parameters
ulFlags
[in] A bitmask of flags that controls table access. The following flags can be set:
MAPI_DEFERRED_ERRORS
Allows GetReceiveFolderTable to return successfully, possibly before the table is fully available to the caller. If the table is not fully available, making a subsequent table call can raise an error.
MAPI_UNICODE
The returned strings are in Unicode format. If the MAPI_UNICODE flag is not set, the strings are in ANSI format.
lppTable
[out] A pointer to a pointer to the receive folder table.
Return value
S_OK
The receive folder table was successfully returned.
Remarks
The IMsgStore::GetReceiveFolderTable method provides access to a table that shows the property settings for all of the message store's receive folders.
Notes to implementers
For a list of required columns in a receive folder table, see Receive Folder Tables.
Implement your receive folder tables to support setting property restrictions on the PR_RECORD_KEY (PidTagRecordKey) property. This enables easy access to particular receive folders.
Notes to callers
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 |
|---|---|---|
| MsgStoreDlg.cpp |
CMsgStoreDlg::OnDisplayReceiveFolderTable |
MFCMAPI uses the IMsgStore::GetReceiveFolderTable method to get the receive folder table to display. |