ISyncSessionState::OnProgress method (winsync.h)
Reports synchronization progress to the application.
Syntax
HRESULT OnProgress(
[in] SYNC_PROVIDER_ROLE provider,
[in] SYNC_PROGRESS_STAGE syncStage,
[in] DWORD dwCompletedWork,
[in] DWORD dwTotalWork
);
Parameters
[in] provider
The role of the provider that is sending this event.
[in] syncStage
The current stage of the synchronization session.
[in] dwCompletedWork
The amount of work that is currently completed in the session. This value is interpreted as being a part of dwTotalWork.
[in] dwTotalWork
The total work for the session.
Return value
The possible return codes include, but are not limited to, the values shown in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
|
provider or syncStage is not a valid value. |
Remarks
This method can be used to report custom progress to the application. When a provider calls this method, the ISyncCallback::OnProgress event is raised.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 7 [desktop apps only] |
| Minimum supported server | Windows Server 2008 R2 [desktop apps only] |
| Target Platform | Windows |
| Header | winsync.h |