Share via


IMailSyncCallBack::RequestSync

Send Feedback

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 Values

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

Pocket PC: Windows Mobile 2003 and later
Smartphone: Smartphone 2002 and later
OS Versions: Windows CE .NET 4.2 and later
Header: cemapi.h
Library: cemapi.lib

See Also

IMailSyncCallBack | IMailSyncHandler | Messaging | SYNCPROGRESSITEM

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.