PowerManagement_ForceSystemPowerDown Function

  • Article

Header: #include <applibs/powermanagement.h>

Forces the system to the Power Down state for a specified number of seconds.

Power Down is the lowest power-consuming state the system is capable of entering while still being able to wake from limited external interrupts or automatically after a time-out.

The time spent in the state may be shorter if an external wakeup interrupt occurs.

int PowerManagement_ForceSystemPowerDown(unsigned int maximum_residency_in_seconds);

Parameters

  • maximum_residency_in_seconds The maximum time, in seconds, the system may be resident in this state before transitioning back to active.

Return value

Returns 0 for success, or -1 for failure, in which case errno will be set to the error value.

Application manifest requirements

To use PowerManagement_ForceSystemPowerDown(), your application must declare the ForcePowerDown value in the PowerControls field of the application manifest.