ISyncChangeBatchBase::SetWorkEstimateForBatch method (winsync.h)

Article
02/22/2024

Sets the work estimate for the batch.

Syntax

HRESULT SetWorkEstimateForBatch(
  [in] DWORD dwWorkForBatch
);

Parameters

[in] dwWorkForBatch

The work estimate for the batch.

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 and typically is understood as the total work for all changes in a single batch and as a portion of the total work estimated for the session.

This value is reported in the OnProgress event.

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