ShutdownManager ShutdownManager ShutdownManager ShutdownManager Class

Definition

Namespace:
Windows.System Windows.System Windows.System Windows.System
Edit

Manages the shutdown of devices that run in fixed-purpose mode.

public : static class ShutdownManagerpublic static class ShutdownManagerPublic Static Class ShutdownManager// You can use this class in JavaScript.
Attributes
ContractVersionAttribute DualApiPartitionAttribute StaticAttribute StaticAttribute ThreadingAttribute
Windows 10 requirements
Device family
Windows IoT Extension SDK (introduced v10.0.10240.0)
API contract
Windows.System.SystemManagementContract (introduced v1)
Capabilities
systemManagement

Remarks

All methods of this class are static, so you do not need to get a ShutdownManager object to use the methods.

This API requires the use of the IoT systemManagement capability. Users can add the following to their Package.appmanifest:<iot:Capability Name="systemManagement"/>

Methods

BeginShutdown(ShutdownKind, TimeSpan) BeginShutdown(ShutdownKind, TimeSpan) BeginShutdown(ShutdownKind, TimeSpan) BeginShutdown(ShutdownKind, TimeSpan)

Edit

Shuts down a device that runs in fixed-purpose mode, and optionally restarts the device after the specified number of seconds.

public : static void BeginShutdown(ShutdownKind shutdownKind, TimeSpan timeout)public static void BeginShutdown(ShutdownKind shutdownKind, TimeSpan timeout)Public Static Function BeginShutdown(shutdownKind As ShutdownKind, timeout As TimeSpan) As void// You can use this method in JavaScript.
Parameters
shutdownKind
ShutdownKind ShutdownKind ShutdownKind ShutdownKind

The type of shutdown to perform, either with or without restarting the device.

timeout
TimeSpan TimeSpan TimeSpan TimeSpan

The amount of time in seconds to wait before restarting the device if shutdownKind is ShutdownKind.Restart.

Additional features and requirements
Device family
Windows IoT Extension SDK (introduced v10.0.10240.0)
API contract
Windows.System.SystemManagementContract (introduced v1)
Capabilities
systemManagement

Remarks

This API requires the use of the IoT systemManagement capability, and the inclusion of iot in the IgnorableNamespaces list. Users can add the following to their Package.appmanifest:<iot:Capability Name="systemManagement"/>, and add iot to their existing list of IgnorableNamespaces.

CancelShutdown() CancelShutdown() CancelShutdown() CancelShutdown()

Edit

Cancels a shutdown of a fixed-purpose device that is already in progress.

public : static void CancelShutdown()public static void CancelShutdown()Public Static Function CancelShutdown() As void// You can use this method in JavaScript.
Additional features and requirements
Device family
Windows IoT Extension SDK (introduced v10.0.10240.0)
API contract
Windows.System.SystemManagementContract (introduced v1)
Capabilities
systemManagement

Remarks

This API requires the use of the IoT systemManagement capability, and the inclusion of iot in the IgnorableNamespaces list. Users can add the following to their Package.appmanifest:<iot:Capability Name="systemManagement"/>, and add iot to their existing list of IgnorableNamespaces.

See Also
BeginShutdown(ShutdownKind, TimeSpan)BeginShutdown(ShutdownKind, TimeSpan)BeginShutdown(ShutdownKind, TimeSpan)BeginShutdown(ShutdownKind, TimeSpan)

EnterPowerState(PowerState) EnterPowerState(PowerState) EnterPowerState(PowerState) EnterPowerState(PowerState)

Edit

Instructs a fixed-purpose device to enter the given power state.

public : static void EnterPowerState(PowerState powerState)public static void EnterPowerState(PowerState powerState)Public Static Function EnterPowerState(powerState As PowerState) As void// You can use this method in JavaScript.
Parameters
powerState
PowerState PowerState PowerState PowerState

The power state to enter.

Additional features and requirements
Device family
Windows IoT Extension SDK (introduced v10.0.15063.0)
API contract
Windows.System.SystemManagementContract (introduced v3)
Capabilities
systemManagement

Remarks

This API requires the use of the IoT systemManagement capability, and the inclusion of iot in the IgnorableNamespaces list. Users can add the following to their Package.appmanifest:<iot:Capability Name="systemManagement"/>, and add iot to their existing list of IgnorableNamespaces.

See Also
EnterPowerState(PowerState, TimeSpan)EnterPowerState(PowerState, TimeSpan)EnterPowerState(PowerState, TimeSpan)EnterPowerState(PowerState, TimeSpan)

EnterPowerState(PowerState, TimeSpan) EnterPowerState(PowerState, TimeSpan) EnterPowerState(PowerState, TimeSpan) EnterPowerState(PowerState, TimeSpan)

Edit

Instructs a fixed-purpose device to enter the given power state, then wake up after the given period of time.

public : static void EnterPowerState(PowerState powerState, TimeSpan wakeUpAfter)public static void EnterPowerState(PowerState powerState, TimeSpan wakeUpAfter)Public Static Function EnterPowerState(powerState As PowerState, wakeUpAfter As TimeSpan) As void// You can use this method in JavaScript.
Parameters
powerState
PowerState PowerState PowerState PowerState

The power state to enter.

wakeUpAfter
TimeSpan TimeSpan TimeSpan TimeSpan

The period of time to remain in the specified power state. After this time elapses, the device will wake up.

Additional features and requirements
Device family
Windows IoT Extension SDK (introduced v10.0.15063.0)
API contract
Windows.System.SystemManagementContract (introduced v3)
Capabilities
systemManagement

Remarks

This API requires the use of the IoT systemManagement capability, and the inclusion of iot in the IgnorableNamespaces list. Users can add the following to their Package.appmanifest:<iot:Capability Name="systemManagement"/>, and add iot to their existing list of IgnorableNamespaces.

See Also
EnterPowerState(PowerState)EnterPowerState(PowerState)EnterPowerState(PowerState)EnterPowerState(PowerState)

IsPowerStateSupported(PowerState) IsPowerStateSupported(PowerState) IsPowerStateSupported(PowerState) IsPowerStateSupported(PowerState)

Edit

Gets whether a given power state is supported on a fixed-purpose device.

public : static PlatForm::Boolean IsPowerStateSupported(PowerState powerState)public static bool IsPowerStateSupported(PowerState powerState)Public Static Function IsPowerStateSupported(powerState As PowerState) As bool// You can use this method in JavaScript.
Parameters
powerState
PowerState PowerState PowerState PowerState

The power state to be examined.

Returns
PlatForm::Boolean bool bool bool

This method returns TRUE if the power state is supported on the specified device, and FALSE otherwise.

Additional features and requirements
Device family
Windows IoT Extension SDK (introduced v10.0.15063.0)
API contract
Windows.System.SystemManagementContract (introduced v3)
Capabilities
systemManagement

Remarks

This API requires the use of the IoT systemManagement capability, and the inclusion of iot in the IgnorableNamespaces list. Users can add the following to their Package.appmanifest:<iot:Capability Name="systemManagement"/>, and add iot to their existing list of IgnorableNamespaces.

See Also