IWinSATInitiateEvents::WinSATUpdate method (winsatcominterfacei.h)

Article
10/13/2021

[IWinSATInitiateEvents::WinSATUpdate may be altered or unavailable for releases after Windows 8.1.]

Receives notification when an assessment is making progress.

Syntax

HRESULT WinSATUpdate(
  [in] UINT    uCurrentTick,
  [in] UINT    uTickTotal,
  [in] LPCWSTR strCurrentState
);

Parameters

[in] uCurrentTick

The current progress tick of the assessment.

[in] uTickTotal

The total number of progress ticks for the assessment.

[in] strCurrentState

A string that contains the current state of the assessment. This string is valid during the life of this callback. Copy the string if you need it after the callback returns.

Return value

This method should return S_OK; the value is ignored.

Remarks

You can use this method to determine the progress of a formal assessment.

Note You can use the uCurrentTick and uTickTotal values to mark progress for formal assessments only; the values are zero for all other assessments.

You should keep your implementation short so you do not miss subsequent updates; you will not get new updates until the method returns.

Note If an instance of WinSAT is already running, it is possible that you could receive one or more update callbacks for the currently running assessment.

Examples

For an example implementation, see the InitiateAssessment or InitiateFormalAssessment method of IInitiateWinSATAssessment.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	winsatcominterfacei.h
DLL	Winsatapi.dll