ProgressIdleValue enumeration

Specifies the type of Idle progress type that has occurred.

Syntax

enum ProgressIdleValue {
  ProgressIdleValueNone                   = 0, 
  ProgressIdleValueBegin, 
  ProgressIdleValueEnd, 
  ProgressIdleValueEnterConnectedStandby, 
  ProgressIdleValueMax 

};

Constants

ProgressIdleValueNone

No idle progress is being reported. This enumerator should never occur at runtime.

ProgressIdleValueBegin

The assessment is beginning an idle period.

ProgressIdleValueEnd

The assessment is ending an idle period.

ProgressIdleValueEnterConnectedStandby

The assessment is beginning a connected standby idle period.

ProgressIdleValueMax

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

Remarks

When measuring the energy efficiency of a system, both active and idle periods must be analyzed. The ProgressTypeIdle progress enumerator is used by workloads running under the Energy Efficiency assessment to mark where the idle periods appear in the traces that are being gathered. This enables analysis after the Energy Efficiency assessment has completed.

Managed code uses the ProgressIdleValue enum.

Requirements

See also

ProgressType