BackgroundTaskCompletedEventHandler Delegate

Reference

Definition

Namespace:: Windows.ApplicationModel.Background

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a method that handles completion events for a background task.

public delegate void BackgroundTaskCompletedEventHandler(BackgroundTaskRegistration ^ sender, BackgroundTaskCompletedEventArgs ^ args);

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(1530456361, 41094, 18087, 166, 120, 67, 145, 53, 130, 43, 207)]
class BackgroundTaskCompletedEventHandler : MulticastDelegate

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(1530456361, 41094, 18087, 166, 120, 67, 145, 53, 130, 43, 207)]
public delegate void BackgroundTaskCompletedEventHandler(BackgroundTaskRegistration sender, BackgroundTaskCompletedEventArgs args);

var backgroundTaskCompletedEventHandlerHandler = function(sender, args){
/* Your code */
}

Public Delegate Sub BackgroundTaskCompletedEventHandler(sender As BackgroundTaskRegistration, args As BackgroundTaskCompletedEventArgs)

Parameters

sender: BackgroundTaskRegistration

The background task.

args: BackgroundTaskCompletedEventArgs

Completion information for the task at the time the notification is sent.

Attributes: ContractVersionAttribute GuidAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Completion events are delivered only if the task completed while the application is in the foreground. If the application is suspended and then terminated, completion status is not delivered. If the application is suspended and then resumed, it is guaranteed to receive the completion notification.

Applies to

Product	Versions
WinRT	Build 10240, Build 10586, Build 14383, Build 15063, Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100

Share via