Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.42 KB

iwebuibackgroundtaskinstance_succeeded.md

File metadata and controls

26 lines (18 loc) · 1.42 KB
-api-id -api-type
P:Windows.UI.WebUI.IWebUIBackgroundTaskInstance.Succeeded
winrt property

Windows.UI.WebUI.IWebUIBackgroundTaskInstance.Succeeded

-description

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.

-property-value

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.

-examples

-see-also