ProgressType enumeration

Describes the type of progress that is being reported from the assessment to the Axe engine.

Syntax

enum ProgressType {
  None             = 0, 
  Percent          = 1, 
  Message          = 2, 
  Heartbeat        = 3, 
  Increment        = 4, 
  Cancelling       = 5, 
  RemainingTime    = 6, 
  WaitingForInput  = 7, 
  OnOff            = 8 

};

Constants

None

There is no progress reported. It should never occur at runtime.

Percent

The progressValue parameter is an integer in the range [0-100] that indicates the percentage complete. The progressMessage parameter is an empty string.

Message

The progressMessage parameter contains a message for the client application to display. This could be the name of a phase or other custom messages. The progressValue parameter is 0 and has no meaning.

Heartbeat

The assessment is still running. The progressValue parameter is 0 and has no meaning. The progressMessage parameter is an empty string.

Increment

The progressValue parameter is one more than the last Increment progress event contained. The progressMessage parameter is an empty string.

Cancelling

The assessment has received a cancellation request and is ending. The progressValue parameter is 0 and has no meaning. The progressMessage parameter is an empty string.

RemainingTime

The assessment has a limited amount of time that it is expecting to run. The progressValue parameter is the estimated number of seconds remaining before the assessment completes. The progressMessage parameter is an empty string.

WaitingForInput

The assessment has presented a user interface or a command line prompt and is waiting for input from the user. The progressValue parameter is 0 and has no meaning. The progressMessage parameter contains a string that explains why the assessment is waiting.

OnOff

The assessment reports that it is controlling a transition of the system s power state. This lets AXE know that the next system Power On transition is intentional and not an error. The progressMessage parameter is an empty string.

The progressValue parameter contains one of the following values :

0 - Reboot (Restart)

1 - Sleep

2 - Hibernate

3 - Full shutdown

4 - Hiber-Shutdown

Requirements