IMAPISupport::GetOneOffTable

Last modified: July 23, 2011

Applies to: Outlook

Returns a pointer to the MAPI one-off table (a list of templates that all address book providers support for creating new recipients).

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

ulFlags

[in] A bitmask of flags that controls the type of the string columns. 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 one-off table.

S_OK

The one-off table was successfully retrieved.

The IMAPISupport::GetOneOffTable method is implemented for address book provider support objects. Address book providers call GetOneOffTable to retrieve the complete list of templates for creating new recipients. This table includes templates that address book providers that are active in the session support, as well as templates that MAPI supports.

The newly created recipients can be used to address a message or can be added to an address book container.

For a list of the properties that make up the required column set in one-off tables, see One-Off 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.

If you are registered to receive notifications of changes to this one-off table, you will also receive notifications of changes to other providers' one-off tables. Based on these notifications, you can support new address types that are added during the current session.

Show: