IOSTX::SyncBeg
Applies to: Outlook 2013 | Outlook 2016
Prepares the local store for synchronization in a particular state and retrieves the necessary information to replicate.
HRESULT SyncBeg(
UINT uiSync,
LPVOID *ppv
);
Parameters
uiSync
[in] The state that the local store will enter. The following is a list of state identifers:
LR_SYNC_IDLE
LR_SYNC
LR_SYNC_UPLOAD_HIERARCHY
LR_SYNC_UPLOAD_FOLDER
LR_SYNC_CONTENTS
LR_SYNC_UPLOAD_TABLE
LR_SYNC_UPLOAD_MESSAGE
LR_SYNC_UPLOAD_MESSAGE_READ
LR_SYNC_UPLOAD_MESSAGE_DEL
LR_SYNC_DOWNLOAD_HIERARCHY
LR_SYNC_DOWNLOAD_TABLE
ppv
[in]/[out] Pointer to the data structure corresponding to the state to enter.
Remarks
The client calls IOSTX::SetSyncResult to set the result of the synchronization, and then calls IOSTX::SyncEnd to end that state. The client must call IOSTX::SyncEnd for each call to IOSTX::SyncBeg in order to determine whether the state has been successfully replicated. Once this has been determined, Outlook can begin to clean up its internal state.
Most of these structures contain [out]/[in] information, allowing Outlook to pass information to the client, and the client to pass information to Outlook. When the client calls IOSTX::SyncBeg, Outlook allocates the data structure for a given state and initializes it with information for that state. This is the [out] information. While in a state, the client updates the corresponding data structure for that state. This is the [in] information.