Share via


Support::IsCanceled method

Determines if there has been a request for the assessment to cancel its operation.

Syntax

virtual HRESULT IsCanceled(
  [out] BOOL *cancelAssessment
) const = 0;

Parameters

cancelAssessment [out]

A Boolean value that indicates whether the solution has requested that the assessment stop its operation.

Return value

If the function succeeds, it returns S_OK. If it fails, it returns an error value.

Remarks

This method enables an assessment to poll for cancellation requests. Polling is not the preferred method for detecting a cancellation request. An assessment will perform better if it waits on a cancel event created by the Axe engine that is signaled by the engine when the request is received from the solution application.

Managed code uses the Support.Canceled property.

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

See also

Support

GetCancelEvent