ISyncChangeBatchBase::SetRemainingWorkEstimateForSession method (winsync.h)

Article
02/22/2024

Sets the estimate of the remaining work for the session.

Syntax

HRESULT SetRemainingWorkEstimateForSession(
  [in] DWORD dwRemainingWorkForSession
);

Parameters

[in] dwRemainingWorkForSession

The estimate of the remaining 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
S_OK	The method succeeded.

Remarks

The work estimate is determined by the provider.

This value is reported in the OnProgress event. If this value is set to zero, the OnProgress event will fire for each change that is applied during the session. It will pass zero for the completed work and total work.

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