BackgroundTaskHelper.Unregister Method
Definition
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.
Overloads
| Unregister(String, Boolean) |
Unregisters a background task. |
| Unregister(Type, Boolean) |
Unregisters a background task. |
| Unregister(IBackgroundTaskRegistration, Boolean) |
Unregisters a background task. |
Unregister(String, Boolean)
- Source:
- BackgroundTaskHelper.cs
- Source:
- BackgroundTaskHelper.cs
- Source:
- BackgroundTaskHelper.cs
Unregisters a background task.
public static void Unregister(string backgroundTaskName, bool forceExit = true);
static member Unregister : string * bool -> unit
Public Shared Sub Unregister (backgroundTaskName As String, Optional forceExit As Boolean = true)
Parameters
- backgroundTaskName
- String
The name of the background task class
- forceExit
- Boolean
Force the background task to quit if it is currently running (at the time of unregistering). Default value is true.
Applies to
Unregister(Type, Boolean)
- Source:
- BackgroundTaskHelper.cs
- Source:
- BackgroundTaskHelper.cs
- Source:
- BackgroundTaskHelper.cs
Unregisters a background task.
public static void Unregister(Type backgroundTaskType, bool forceExit = true);
static member Unregister : Type * bool -> unit
Public Shared Sub Unregister (backgroundTaskType As Type, Optional forceExit As Boolean = true)
Parameters
- backgroundTaskType
- Type
The type of the background task
- forceExit
- Boolean
Force the background task to quit if it is currently running (at the time of unregistering). Default value is true.
Applies to
Unregister(IBackgroundTaskRegistration, Boolean)
- Source:
- BackgroundTaskHelper.cs
- Source:
- BackgroundTaskHelper.cs
- Source:
- BackgroundTaskHelper.cs
Unregisters a background task.
public static void Unregister(Windows.ApplicationModel.Background.IBackgroundTaskRegistration backgroundTask, bool forceExit = true);
static member Unregister : Windows.ApplicationModel.Background.IBackgroundTaskRegistration * bool -> unit
Public Shared Sub Unregister (backgroundTask As IBackgroundTaskRegistration, Optional forceExit As Boolean = true)
Parameters
- backgroundTask
- Windows.ApplicationModel.Background.IBackgroundTaskRegistration
A background task that was previously registered with the system
- forceExit
- Boolean
Force the background task to quit if it is currently running (at the time of unregistering). Default value is true.