AxeProgressType Enumeration

Applies To: Windows 8.1

Describes the progress reported by the assessment to the AXE engine in ReportProgress.

Namespace: Microsoft.Assessments
Assembly: Microsoft.Assessments.Core (in Microsoft.Assessments.Core.dll)
'Usage
Dim instance As AxeProgressType

public enum AxeProgressType
public enum AxeProgressType
public enum AxeProgressType
Member nameDescription
CancellingThe 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.
ErrorThe progressMessage parameter contains an error message for the application to display. The application can display it to differentiate it from basic messages or warnings. The progressValue parameter is 0 and has no meaning.
HeartbeatThe assessment is still running. The progressValue parameter is 0 and has no meaning. The progressMessage parameter is an empty string.
IdleThis 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.
IncrementThe value of the progressValue parameter is one greater than the last progress event increment. The progressMessage parameter is an empty string.
InvalidAn invalid progress type was reported. This enumerator is most often used to check the range of the enumerator values. It should not be used to report an actual progress type.
MessageThe progressMessage parameter contains a message for the application to display. This could be the name of a phase or other custom message. The progressValue parameter is 0 and has no meaning.
NoneThere is no progress reported. This enumerator should never occur at runtime.
OnOffThe 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.
PercentThe progressValue parameter is an integer in the range from 0-100 that indicates the percentage complete. The progressMessage parameter can contain an optional message for the application to display.
RemainingTimeThe 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.
TestCaseThe progressMessage parameter contains a message for the application to display. The progressValue parameter is zero if the progressMessage indicates a failure and a value other than zero if the progressMessage indicates a successful result.
WaitingForInputThe assessment has presented a user interface or a command 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.
WarningThe progressMessage parameter contains a warning message for the application to display. The application can display it to differentiate it from basic messages or errors. The progressValue parameter is 0 and has no meaning.

Development Platforms

Windows 8.1

 

Show:
© 2014 Microsoft. All rights reserved.