HrDispatchNotifications

  • Article

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Forces dispatching of all queued notifications.

Header file:

Mapiutil.h

Implemented by:

MAPI

Called by:

Client applications and service providers

 
HRESULT HrDispatchNotifications(
  ULONG ulFlags
);

Parameters

  • ulFlags
    [in] Reserved; must be zero.

Return Value

  • S_OK
    All queued notifications have been dispatched.

  • MAPI_E_USER_CANCEL
    WM_QUIT, WM_QUERYENDSESSION, or WM_ENDSESSION was received.

  • MAPI_E_NOT_INITIALIZED
    MAPI was not initialized.

Remarks

The HrDispatchNotifications function causes MAPI to dispatch all notifications that are currently queued in the MAPI notification engine without waiting for a message dispatch. This can have a beneficial effect on memory utilization. For more information, see Forcing a Notification.

Notes to Callers

Some applications wait for a notification message in a timeout loop using the Windows PeekMessage and DispatchMessage functions. On all but the fastest platforms, such applications might experience poor performance or even blockage of notifications. Using HrDispatchNotifications not only reduces code but improves performance.