Job::GetCurrentAssessmentIndex method

  • Article

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

Retrieve the assessment index of the assessment that is currently running.

Syntax

HRESULT GetCurrentAssessmentIndex(
  [out, ref]  UINT &currentIndex
);

Parameters

  • currentIndex [out, ref]
    The index of the currently running assessment. If the job is not running, currentIndex receive 0.

Return value

If the assessment index is retrieved successfully, return S_OK.

If the job is not currently running, return AXE_E_JOB_NOT_RUNNING.

Remarks

The index of the assessment that is currently running is updated as the job runs. This method can be called at any time while the job is running.

See also

Job

 

 

Build date: 9/6/2011