BackgroundTaskCancellationReason BackgroundTaskCancellationReason BackgroundTaskCancellationReason BackgroundTaskCancellationReason BackgroundTaskCancellationReason Enum

Definition

Specifies the reasons for cancelling a background task.

public : enum class BackgroundTaskCancellationReason
enum class winrt::Windows::ApplicationModel::Background::BackgroundTaskCancellationReason : int32_t
public enum BackgroundTaskCancellationReason
Public Enum BackgroundTaskCancellationReason
var value = Windows.ApplicationModel.Background.BackgroundTaskCancellationReason.abort;
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Fields

Abort Abort Abort Abort Abort 0

The background task was canceled by the application. This can happen for one of the following four reasons:

  • The task is considered an idle task. This means that the background task is still running, but without doing anything – for example, a JavaScript task that does not call the close() function.
  • The background task uses the MaintenanceTrigger and the system transitions to DC (battery power).
  • The app unregisters the background task, in which case the task is cancelled if it is currently running.
  • The app that registered the background task is uninstalled while the task is running.
ConditionLoss ConditionLoss ConditionLoss ConditionLoss ConditionLoss 6

The background task was canceled because one or more of its required conditions is no longer met.

EnergySaver EnergySaver EnergySaver EnergySaver EnergySaver 11

The background task was cancelled because of the current Energy Saver policy.

ExecutionTimeExceeded ExecutionTimeExceeded ExecutionTimeExceeded ExecutionTimeExceeded ExecutionTimeExceeded 9

The background task was cancelled because it exceeded its allotted time to run.

IdleTask IdleTask IdleTask IdleTask IdleTask 4

The background task was canceled because it was active, but not doing any work.

LoggingOff LoggingOff LoggingOff LoggingOff LoggingOff 2

The background task was canceled because the user has logged off the system.

QuietHoursEntered QuietHoursEntered QuietHoursEntered QuietHoursEntered QuietHoursEntered 8

The background task was cancelled because the device entered the quiet hours period.

Note

QuietHoursEntered is no longer available for use as of Windows 10.

ResourceRevocation ResourceRevocation ResourceRevocation ResourceRevocation ResourceRevocation 10

The background task was cancelled because the system needed additional resources. The background task was cancelled to free up those resources.

ServicingUpdate ServicingUpdate ServicingUpdate ServicingUpdate ServicingUpdate 3

The background task was canceled because the application was updated.

SystemPolicy SystemPolicy SystemPolicy SystemPolicy SystemPolicy 7

The background task was cancelled because of system policy.

Terminating Terminating Terminating Terminating Terminating 1

The background task was canceled because the application is about to be terminated due to system policy. The application should save any state that will be needed when the application restarts.

Uninstall Uninstall Uninstall Uninstall Uninstall 5

The background task was canceled because the application was uninstalled.