Share via

IMailSyncCallBack::LogEvent

  • Article

4/8/2010

The LogEvent method logs an error event with Messaging.

Syntax

HRESULT LogEvent (
  TRANSPORTEVENT * pevt
);

Parameters

  • pevt
    [in] An instance of a TRANSPORTEVENT structure that should be logged by Messaging; cannot be NULL.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

  • S_OK
    Indicates success.

Remarks

Rather than DIMailSyncCallBack::DisplayMessageBox, LogEvent should be used to display transport errors to the user, because calling LogEvent does not block the synchronization thread and the message is displayed to the user immediately.

If an error occurs during a mail synchronization session, the transport might need to bring that to the user's attention. After calling LogEvent to log the event, Messaging calls IMailSyncHandler::DecodeEvent to decode the event into a readable string so that it can be displayed to the user.

Requirements

Header cemapi.h
Library cemapi.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Pocket PC 2002 and later, Smartphone 2002 and later

See Also

Reference

IMailSyncCallBack
IMailSyncHandler::DecodeEvent
IMailSyncCallBack::DisplayMessageBox
TRANSPORTEVENT

Other Resources

Messaging