Support::ReportProgress method

Article
05/31/2018

Reports the progress of the assessment to the AXE engine and can inform the assessment if it should stop running.

Syntax

virtual HRESULT ReportProgress(
  [in]            AxeProgressType progressType,
  [in]            UINT            progressValue,
  [in, optional]  LPCWSTR         progressMessage,
  [out, optional] BOOL            *cancelAssessment
) const = 0;

Parameters

progressType [in]: The type of progress data that is contained within the other parameters.
progressValue [in]: An integer value that is interpreted according to the progressType parameter.
progressMessage [in, optional]: A string that is interpreted according to the progressType parameter.
cancelAssessment [out, optional]: Indicates whether the AXE engine has received a request for the assessment to stop running.

Return value

If the function succeeds, the return value is S_OK.

If the parameters are invalid with respect to progressType, the return value is E_INVALIDARG.

Remarks

The parameters to this method enable the assessment to report different types of progress to an application. Applications can display the information.

See the definition of the ProgressType enumeration for restrictions and error conditions.

Managed code uses the Support.ReportProgress method.

Requirements


Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Header	AxeRuntime.h
DLL	AxeCore.dll

Share via