Share via


OnOffProgressValue enumeration

The types of power transitions Axe can track. It also specifies the type of tracing the OnOffHelper API provides.

Syntax

enum OnOffProgressValue {
  None                = 0, 
  NotifyOnly          = 0, 
  CancelNotification, 
  HybridBoot, 
  Boot, 
  Shutdown, 
  RebootCycle, 
  Standby, 
  Hibernate, 
  Max 

};

Constants

None

The assessment will be performing a power transition itself, but Axe does not need to do anything.

NotifyOnly

The assessment will be performing a power transition itself, but Axe does not need to do anything.

CancelNotification

The assessment will not be performing the previously-reported power state transition.

HybridBoot

The assessment will be rebooting the system using the HybridBoot technology.

Boot

The assessment will be restarting the system using a full shutdown and restart.

Shutdown

The assessment will shutdown the system. Tracing will only extend until the system powers off.

RebootCycle

The assessment is requesting tracing through both a shutdown and the subsequent start of the system.

Standby

The assessment will be transitioning the system into Standby mode.

Hibernate

The assessment will be hibernating the system.

Max

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

Remarks

Before an assessment causes the system to power down or restart, it must notify Axe of the upcoming power state transition so that Axe ensures that the assessment will be restarted upon a user logging into the operating system again. Once a notification has been made, the assessment should send the CancelNotification enumerator if the assessment decides not to perform the transition that was previously reported so that Axe will not restart the assessment.

Managed code uses the OnOffProgressValue enum.

Requirements

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

See also

ProgressType