AllTasks | allTasks property
Collapse the table of content
Expand the table of content

BackgroundTaskRegistration.AllTasks | allTasks property

Enumerates an application's registered background tasks.

Syntax


public static IReadOnlyDictionary<Guid, IBackgroundTaskRegistration> AllTasks { get; }

Property value

Type: IMapView<Guid, IBackgroundTaskRegistration> [JavaScript/C++] | System.Collections.Generic.IReadOnlyDictionary<Guid, IBackgroundTaskRegistration> [.NET]

A view into a map of registered background tasks consisting of the task ID and an IBackgroundTaskRegistration interface.

Examples

The following example shows how to use the AllTasks property of the BackgroundTaskRegistration class to retrieve the existing background task registration object for your app's background task (if the task is currently registered).


// The name of the background task for your app.
string name = "ExampleTaskName";

// Get a list of all background tasks. The list is returned as
// a dictionary of IBackgroundTaskRegistration objects.
foreach (var cur in BackgroundTaskRegistration.AllTasks)
{
    if (cur.Value.Name == name)
    {
        // Take some action based on finding the background task.
        //
        // For example, unregister the task: cur.Value.Unregister(true);
        // Or, set a global variable indicating that the task is already registered
    }
}

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.ApplicationModel.Background
Windows::ApplicationModel::Background [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.ApplicationModel.Background
Windows::ApplicationModel::Background [C++]

Metadata

Windows.winmd

See also

BackgroundTaskRegistration

 

 

Show:
© 2016 Microsoft