Edit

IOSTX::SyncHdrBeg

  • Article

Applies to: Outlook 2013 | Outlook 2016

Starts synchronization for a message header.

HRESULT SyncHdrBeg( 
    ULONG cbeid, 
    LPENTRYID lpeid, 
    LPVOID *ppv 
);

Parameters

cbeid

[in] The number of bytes in the entry ID for the message.

lpeid

[in] The entry ID for the message.

ppv

[in]/[out] Pointer to the HDRSYNC structure for the message header.

Remarks

Upon IOSTX::SyncHdrBeg, the local store transitions to the download message header state. Outlook initializes for the client the HDRSYNC structure with the current representation of the message header in the store and the parent folder. The client must then download a full message item (as pmsgFull in HDRSYNC ). If this was successful, the client also sets ulFlags in HDRSYNC as HSF_OK. Upon IOSTX::SyncHdrEnd, Outlook checks the result in HDRSYNC and uses the information in HDRSYNC to update the local message header.

See also

IOSTX::GetLastError
IOSTX::InitSync
IOSTX::SetSyncResult
IOSTX::SyncBeg
IOSTX::SyncEnd
IOSTX::SyncHdrEnd
IOSTX : IUnknown MAPI Constants