ISyncChangeBatchBase::GetRemainingWorkEstimateForSession method (winsync.h)

Gets the estimate of the remaining work for the session.

Syntax

HRESULT GetRemainingWorkEstimateForSession(
  [out] DWORD *pdwRemainingWorkForSession
);

Parameters

[out] pdwRemainingWorkForSession

The estimated remaining work for the session. 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 remaining work estimated for a 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