IReconcileInitiator::SetProgressFeedback

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
No
Import Library
-
Header File
reconcil.h
Unicode
No
Platform Notes
None

[Now Supported on Windows NT]

Indicates the amount of progress the briefcase reconciler has made toward completing the reconciliation. The amount is a fraction of 1 and is computed as the quotient of the ulProgress and ulProgressMax. Reconcilers should call this member function periodically during their reconciliation process.

The initiator typically uses this measure of progress to update a thermometer gauge or some other form of visual feedback for the user. The briefcase reconciler can change the value of ulProgressMax from call to call. This means successive calls to this member function do not necessarily indicate steady forward progress. Backward progress is legal, although not desirable. It is the responsibility of the initiator to determine whether backward progress should be revealed to the user.

HRESULT IReconcileInitiator::SetProgressFeedback(

ULONG ulProgress,
ULONG ulProgressMax
);

Parameters
ulProgress

Numerator of the progress fraction.

ulProgressMax

Denominator of the progress fraction.

Return Values
Returns the S_OK value if successful or the E_UNEXPECTED value if some unspecified error occurred.