AxeProgressType enumeration

Describes the type of progress that is being reported by the assessment to the Axe engine in ReportProgress methods.

Syntax

enum ProgressType {
  ProgressTypeNone             = 0, 
  ProgressTypePercent, 
  ProgressTypeMessage, 
  ProgressTypeHeartbeat, 
  ProgressTypeIncrement, 
  ProgressTypeCancelling, 
  ProgressTypeRemainingTime, 
  ProgressTypeWaitingForInput, 
  ProgressTypeOnOff, 
  ProgressTypeWarning, 
  ProgressTypeError, 
  ProgressTypeTestCase, 
  ProgressTypeIdle, 
  ProgressTypeInvalid 

};

Constants

ProgressTypeNone

There is no progress reported. This enumerator should never occur at runtime.

ProgressTypePercent

The progressValue parameter is an integer in the range [0-100] that indicates the percentage complete. The progressMessage parameter can contain an optional message for the application to display.

ProgressTypeMessage

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

ProgressTypeHeartbeat

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

ProgressTypeIncrement

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

ProgressTypeCancelling

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.

ProgressTypeRemainingTime

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.

ProgressTypeWaitingForInput

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.

ProgressTypeOnOff

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 values from the OnOffProgressValue enumeration.

ProgressTypeWarning

The progressMessage parameter contains a message for the application to display. This message is a warning message and the application can display it to differentiate it from basic messages or errors. The progressValue parameter is 0 and has no meaning.

ProgressTypeError

The progressMessage parameter contains a message for the application to display. This message is an error message and the application can display it to differentiate it from basic messages or warnings. The progressValue parameter is 0 and has no meaning.

ProgressTypeTestCase

The progressMessage parameter contains a message for the application to display. The progressValue parameter is non-zero if the progressMessage indicates a successful result and zero if the progressMessage indicates a failure.

ProgressTypeIdle

This enumerator is only used by workloads executed by the Energy Efficiency assessment to report when an idle period occurs so that the energy used during that period can analyzed. The progressValue parameter is a value from the ProgressIdleValue enumeration. The progressMessage parameter is an empty string.

ProgressTypeInvalid

An invalid progress type was reported. This enumerator is most often used for range checking the enumerator values. It should not be used to report an actual progress type.

Remarks

Managed code uses the AxeProgressType enum.

Requirements

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