Share via


Engine::TerminateJob method

This method ends an entire job without waiting for any assessment to exit.

Note

TerminateJob ends the current assessment abruptly by calling the TerminateProcess function, this can leave the system in an unrecoverable state. TerminateJob should be used only as a last resort.

Syntax

virtual HRESULT TerminateJob() = 0;

Parameters

This method has no parameters.

Return value

If the job is successfully terminated, the method returns S_OK.

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

If the job was not terminated, the method returns AXE_E_TERMINATE_FAILED.

Remarks

Unlike the CancelAssessment and CancelJob methods, this is a synchronous call.

This method will still raise an assessment end and job end event.

Managed code uses the Engine.TerminateJob | terminateJob 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

TerminateProcess