IBackgroundTaskInstance2 IBackgroundTaskInstance2 IBackgroundTaskInstance2 IBackgroundTaskInstance2 Interface

Definition

Provides access to a background task instance. Inherits from the IBackgroundTaskInstance interface and adds the GetThrottleCount method.

public : interface IBackgroundTaskInstance2public interface IBackgroundTaskInstance2Public Interface IBackgroundTaskInstance2// You can use this interface in JavaScript.
Inheritance
IBackgroundTaskInstance2IBackgroundTaskInstance2IBackgroundTaskInstance2IBackgroundTaskInstance2
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited events

Inherited methods

Inherited properties

Methods

GetThrottleCount(BackgroundTaskThrottleCounter) GetThrottleCount(BackgroundTaskThrottleCounter) GetThrottleCount(BackgroundTaskThrottleCounter) GetThrottleCount(BackgroundTaskThrottleCounter)

Retrieves the number of times the background task has been suspended for using too many resources.

public : unsigned int GetThrottleCount(BackgroundTaskThrottleCounter counter)public uint GetThrottleCount(BackgroundTaskThrottleCounter counter)Public Function GetThrottleCount(counter As BackgroundTaskThrottleCounter) As uint// You can use this method in JavaScript.
Parameters
counter
BackgroundTaskThrottleCounter BackgroundTaskThrottleCounter BackgroundTaskThrottleCounter BackgroundTaskThrottleCounter

Indicates the type of resource to include in the throttle count: network, CPU, or both.

Returns
unsigned int uint uint uint

This method returns the number of times the background task has been suspended for exceeding its quota of the indicated resource type.

See Also