OS_JumpToSystemMenu

Syntax

#include <nitro/os.h>

BOOL OS_JumpToSystemMenu( void );

Arguments

None.

Return Values

Returns FALSE if running in NITRO mode.
If running in TWL mode, this function normally succeeds but control is not returned.

Description

Performs a hardware reset and returns to the System Menu.

This function cannot be called when interrupts are disabled.
Because this function cannot be called during the exit process either, take care that it is not executed from within an exit callback registered using functions such as the PM_Append*ExitCallback functions.

The PM_ForceToResetHardwarefunction is used internally by this function. Making a direct call to the PM_ForceToResetHardware function also returns the process to the System Menu. TWL has a mechanism to write parameters at the beginning of main RAM, thus enabling you to change the initial process after a hardware reset. If an unintended value is written to this parameter, the call to PM_ForceToResetHardware may not return the process to the System Menu. Because of this possibility, use the OS_JumpToSystemMenu function to return to the System Menu.

See Also

PM_ForceToResetHardware
PM_Append*ExitCallback
PM_Prepend*ExitCallback
PM_Insert*ExitCallback

Revision History

2008/10/22 Added the fact that execution during exit processing is prohibited.
2008/09/08 Revised the icon.
2008/08/05 Initial version.


CONFIDENTIAL