Edit

What's New in This Edition

  • Article

Applies to: Outlook 2013 | Outlook 2016

The Microsoft Outlook MAPI Reference has been updated to include documentation for various new features.

New Content

Content has been added for the following features:

MAPI Initialization Monitor

  • There are times when an application which consumes MAPI might want to know when the initialization is completed. For example, it have multiple threads which could initialize MAPI, or in response to MAPI being initialize the application would like perform some work, but does not want to always spin up the MAPI stack. The initialization monitor provides this functionality through a function (exported from OLMAPI32.DLL) and a couple of simple interfaces described below.

HRESULT STDAPICALLTYPE CreateMapiInitializationMonitor(IMAPIInitMonitor ppInitMonitor)

  • This is entry point exported from OLMAPI32.DLL this allows the caller to retrieve an interface to query the current initialization state, setup a callback for initialization completion or block the current thread until has completed. The object returned from this API is reusable and thread safe and can be invoked from any thread, not just thread which retrieved it. Also, unlike other objects exposed from MAPI, this object is valid as long as the DLL is loaded, it can be re-used across initialization sessions and can be consumed before or after MAPIInitialize has been called. Returns success or failure through an COM standard HRESULT, and assigns an out parameter to an instance of IMAPIInitMonitor.

Interface: IMAPIInitMonitor

IFACEMETHODIMP_(BOOL) IsInitialized()

  • Returns the current state of MAPI initialization

IFACEMETHODIMP Wait(DWORD timeout)

  • Initiates a BLOCKING call on this thread, which will return either when the specified number of milliseconds have elapsed or MAPI has been initialized. INFINITE can be used to for an infinite wait.

IFACEMETHODIMP BeginWait(DWORD timeout, IMAPIWaitResult ppResult)

  • Start a wait for MAPI initialization or the specified number of milliseconds to elapse. This return an IMAPIWaitResult interface which should have “End” called in order begin the wait. This allows the caller to control which thread is blocked while we are waiting.

Interface IMAPIWaitResult

IFACEMETHODIMP End() override

  • Called to initiate the blocking wait on the thread where it is called, does not need to be the same thread that called “BeginWait”.

Previously Revised Content

Content was added in previous releases of the Outlook MAPI Reference for the following features:

  • Microsoft Outlook 2013 allows for non-traditional deployment scenarios such as side-by-side and Click-to-Run. These scenarios can complicate the logic used to load the proper MAPI library. MAPI developers now have the option of linking explicitly to MAPI functions, and can choose to explicitly link to the MAPI stub of the default MAPI client (for example, Msmapi32.dll of Outlook) without going through the MAPI library and the Windows MAPI stub. For more information about explicit linking as compared with implicit linking, see Link to MAPI Functions.

  • Support for 64-bit Microsoft Outlook—Reference topics for applicable API elements were updated to correspond to new header files that support 64-bit Outlook. Those header files are available as a download at Outlook 2010: MAPI Header Files. A new code sample was provided in Check the Version of Outlook to show how to check whether the installed version of Outlook is 64-bit Microsoft Outlook 2010 and has been revised for Outlook 2013. If your existing 32-bit MAPI application is going to be running on a 64-bit operating system with 64-bit Outlook installed, you will need to rebuild your 32-bit application as a 64-bit application. For more information about MAPI support for 64-bit Outlook, see Building MAPI Applications on 32-Bit and 64-Bit Platforms.

  • Message Store Provider Example—The Sample Wrapped PST Store Provider had previously been updated to support 64-bit architecture. The Example's Initializing a Wrapped PST Store Provider topic has now been expanded to provide information about the "Wrapped PST and Unicode Paths."

  • Autocomplete Stream—The Nickname cache topic, formerly the Nk2 File Format, has been updated to reflect changes in Outlook 2013 as well as Outlook 2010. Information such as the autocomplete list, which is the list of names that displays in the To, Cc, and Bcc edit boxes while a user is composing an email, is now saved to the Autocomplete Stream of a message on the local computer rather than saving it to a file as in Outlook 2007.

    • Interacting with the Autocomplete Stream

    • Loading the Autocomplete Stream

    • Saving the Autocomplete Stream

  • Fast shutdown support for MAPI clients—MAPI clients can now initiate a quick shutdown and have the MAPI subsystem notify loaded providers to minimize data loss from the fast shutdown. Additional interfaces were added for the client and provider to support fast shutdown. For more information about fast shutdown, see Client Shutdown in MAPI.

  • Stream structure for field definitions for an Outlook item—Documentation for a binary stream for the PidLidPropertyDefinitionStream property was added. This property specifies definitions of all custom fields and data-binding settings for built-in fields of an Outlook item.

  • Personal Store Override—The following interfaces and their respective methods were added to support overriding the Personal Folders file (PST) store providers PSTDisableGrow policy:

    IPSTOVERRIDEREQ::IUnknown

    IPSTOVERRIDE1::IUnknown

  • Using Multiple Exchange Accounts—Documentation for the MAPI Address Book API was added. This API was enhanced to support multiple Exchange accounts in Microsoft Outlook 2010 and now includes Microsoft Outlook 2013. To resolve addresses correctly with multiple Exchange accounts, use the new functions that take an account context so that calls to the address book search the correct Exchange account.

  • MAPI File Formats—MAPI configuration information has been expanded to explain how you can use paths in Registering Services and Service Providers in MapiSvc.inf.

  • Properties—The following tagged properties were added in addition to documentation for 38 other tagged properties and named properties that had previously been added:

  • MAPI Constants—The consolidated MAPI Constants have been expanded. In previous releases, they were distributed in a number of topics but are now collected in a single topic to make them easier to discover and use. They have also been expanded to provide more extensive coverage including the following sections:

    • Definitions for Exchange Address Book and Message Store Error Codes

    • Definitions for Exchange Server Mailbox Cached Mode Quotas

See also

Getting Started with the Outlook MAPI Reference

CodePlex