IWebUIBackgroundTaskInstance.Succeeded property

Applies to Windows and Windows Phone

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.

Syntax


bool Succeeded { get; set; }

Property value

Type: System.Boolean [.NET] | Platform::Boolean [C++]

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.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.WebUI
Windows::UI::WebUI [C++]

Metadata

Windows.winmd

See also

IWebUIBackgroundTaskInstance

 

 

Show:
© 2014 Microsoft