IWebUIBackgroundTaskInstance.Succeeded Property

Definition

Namespace:

Windows.UI.WebUI

Gets or sets the success value for the background task. The success value is what is returned to the foreground instance of your app in the completed event.

public:
 property bool Succeeded { bool get(); void set(bool value); };

bool Succeeded();

void Succeeded(bool succeeded);

public bool Succeeded { get; set; }

var boolean = iWebUIBackgroundTaskInstance.succeeded;
iWebUIBackgroundTaskInstance.succeeded = boolean;

Public Property Succeeded As Boolean

Property Value

Boolean

bool

An app can set this property to false to indicate that the background task has failed. Otherwise this property is always true.

Remarks

An app can set this property to false to indicate that the background task has failed. Otherwise this property is always true. The foreground instance of your app can check if the task succeeded using the completed event. The checkResult method on the event args will throw an exception if the succeeded property is set to false.

Note

Once the background task sets this property and has therefore completed its work, the task must explicitly call the Web Workers close method to terminate itself.