I​Background​Task​Instance2 I​Background​Task​Instance2 I​Background​Task​Instance2 Interface

Definition

Namespace:
Windows.ApplicationModel.Background Windows.ApplicationModel.Background Windows.ApplicationModel.Background
Edit

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

public : interface IBackgroundTaskInstance2public interface IBackgroundTaskInstance2Public Interface IBackgroundTaskInstance2
Inheritance
IBackgroundTaskInstanceIBackgroundTaskInstanceIBackgroundTaskInstance
IBackgroundTaskInstance2IBackgroundTaskInstance2IBackgroundTaskInstance2
Attributes
ContractVersionAttribute GuidAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited events

CanceledCanceledCanceled

Inherited methods

GetDeferralGetDeferralGetDeferral

Inherited properties

InstanceIdInstanceIdInstanceId
ProgressProgressProgress
SuspendedCountSuspendedCountSuspendedCount
TaskTaskTask
TriggerDetailsTriggerDetailsTriggerDetails

Methods

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

Edit

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

public : unsigned short GetThrottleCount(BackgroundTaskThrottleCounter counter)public uint GetThrottleCount(BackgroundTaskThrottleCounter counter)Public Function GetThrottleCount(counter As BackgroundTaskThrottleCounter) As uint
Parameters
counter
BackgroundTaskThrottleCounter BackgroundTaskThrottleCounter BackgroundTaskThrottleCounter

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

Returns
unsigned short uint uint

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

Attributes
ContractVersionAttribute GuidAttribute

See Also