IReconcilableObject::GetProgressFeedbackMaxEstimate method (reconcil.h)

  • Article

Retrieves an estimated measurement of the amount of work required to complete a reconciliation. Reconcilers typically use this method to estimate the work needed to reconcile an embedded document. This value corresponds to a similar value that is passed with the SetProgressFeedback method during reconciliation.

Syntax

HRESULT GetProgressFeedbackMaxEstimate(
  PULONG pulProgressMax
);

Parameters

pulProgressMax

Type: ULONG*

The address of the variable to receive the work estimate value.

Return value

Type: HRESULT

Returns S_OK if successful, or one of the following error values otherwise.

Return code Description
OLE_E_NOTRUNNING
 The object is an OLE embedded document that must be run before this operation can be carried out. The object state is unchanged as a result of the call.
E_UNEXPECTED
 Unspecified error.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header reconcil.h
DLL Shell32.dll (version 4.0 or later)

See also

IReconcilableObject