Partager via


Engine::CancelJob method

Requests that the current assessment stop running and the job end without running any more assessments.

Syntax

virtual HRESULT CancelJob() = 0;

Parameters

This method has no parameters.

Return value

If the cancel request is signaled successfully, the method returns S_OK.

If AXE is not currently running a job, the method returns AXE_E_NO_JOB_RUNNING.

Remarks

This method cancels the entire job. Once the currently running assessment completes, no further assessments are run for the job, and the job terminates with the cancellation error.

Managed code uses the Engine.CancelJob | cancelJob method.

Requirements

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

See also

Engine

CancelAssessment

TerminateJob