IMAPISession::GetStatusTable
Applies to: Office 2010 | Outlook 2010 | Visual Studio
Provides access to the status table, a table that contains information about all the MAPI resources in the session.
HRESULT GetStatusTable(
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.
- MAPI_UNICODE
lppTable
[out] A pointer to a pointer to the status table.
Return Value
- S_OK
The table was successfully returned.
Remarks
The IMAPISession::GetStatusTable method provides access to the status table that contains information about all of the MAPI resources in the session. There is one row in the table for information about the MAPI subsystem, one row for the MAPI spooler, one row for the integrated address book, and one row for each service provider in the profile.
For a complete list of required and optional columns in the status table, see Status Tables.
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::OnStatusTable |
MFCMAPI uses the IMAPISession::GetStatusTable method to obtain the status table to be rendered. |