OSGetShutdownReason

Syntax

#include <cafe/os.h>

u32 OSGetShutdownReason(void);

Parameters

None.

Return Values

Returns 0 if no shutdown is in progress. Returns 1 if the shutdown is a power-off. Returns 2 if the shutdown is a restart.

Description

This API is designed to be called while the system is shutting down to determine the reason for the system shutdown. Typically, this is called after a process main entry point has been exited in various callbacks to determine system or process behavior. The following values are returned:

    #define OS_SHUTDOWN_NO_SHUTDOWN 0
    #define OS_SHUTDOWN_POWER_OFF   1
    #define OS_SHUTDOWN_RESTART     2

Do Not Call From

None.

See Also

OSGetShutdownFlags

Revision History

2013/05/08 Automated cleanup pass.
2012/10/02 Initial version.


CONFIDENTIAL