ISyncChangeBatchBase::GetWorkEstimateForBatch method (winsync.h)

  • Article

Gets the work estimate for the batch.

Syntax

HRESULT GetWorkEstimateForBatch(
  [out] DWORD *pdwWorkForBatch
);

Parameters

[out] pdwWorkForBatch

Returns the work estimate for the batch. The default value is 0.

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.
E_POINTER
 Invalid pointer.

Remarks

The work estimate is determined by the provider and is typically 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

See also

ISyncChangeBatchBase Interface