BackgroundAgent.NotifyComplete Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Informs the operating system that the agent has completed its intended task for the current invocation of the agent.

Namespace: Microsoft.Phone
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)

Syntax

Protected Sub NotifyComplete
protected void NotifyComplete()

Remarks

Background agents should always call NotifyComplete when their task is complete so that the operating system can allocate unused resources to other background processes. Because this call will end background agent execution, it can be called only once per invocation. This method can be called from any thread, including background threads. Calling NotifyComplete does not affect future scheduled launches of the agent.

If your agent becomes unable to perform its intended tasks, and should not be launched again, you should call Abort()()() to prevent the agent from being scheduled to run again.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Platforms

Windows Phone

See Also

Reference

BackgroundAgent Class

Microsoft.Phone Namespace