Share via

IMailSyncCallBack::RequestSync

  • Article

4/8/2010

The RequestSync method allows the transport to request that it be synchronized.

Syntax

HRESULT RequestSync (
  LPCWSTR pszProfile,
  DWORD cbCookie,
  LPBYTE pbCookie
);

Parameters

  • pszProfile
    [in] Reference to the string representing the account (profile) name of the transport instance requesting the synchronization.
  • cbCookie
    [in] The size (in bytes) of the memory pointed to by pbCookie.
  • pbCookie
    [out] Reference to the transport-specific data.

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

The Microsoft Messaging Application adds the synchronization request to its synchronization queue, and returns the cookie information to the transport when synchronization completes.

Requirements

Header cemapi.h
Library cemapi.lib
Windows Embedded CE Windows CE .NET 4.2 and later
Windows Mobile Pocket PC for Windows Mobile 2003 and later, Smartphone 2002 and later

See Also

Reference

IMailSyncCallBack
IMailSyncHandler
SYNCPROGRESSITEM

Other Resources

Messaging