Engine::CancelAssessment method

[This documentation is preliminary and is subject to change.]

Asynchronously requests that the specified assessment stop running.

Syntax

HRESULT CancelAssessment(
  [in]  UINT asmtIndex
);

Parameters

  • asmtIndex [in]
    The index of the assessment to cancel. The assessment can only be cancelled when it is running. An assessment’s index is its position in the job list.

Return value

If the method succeeds, return S_OK.

If asmtIndex does not match the index of the currently running assessment, ignore the cancel request and return AXE_E_INVALID_INDEX.

If no job is currently running, return AXE_E_NO_JOB_RUNNING.

See also

Engine

 

 

Build date: 9/6/2011