OSGetShutdownFlags

Syntax

#include <cafe/os.h>

u32 OSGetShutdownFlags(void);

Parameters

None.

Return Values

Returns 0 if no shutdown is in progress. See other bit field values below.

Description

This API is designed to be called while the system is shutting down to determine whether the system shutdown was caused by an auto-power event. 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_FLAG_NO_FLAGS           0x00000000
    #define OS_SHUTDOWN_FLAG_APD_REQUEST        0x00000001

Do Not Call From

None.

See Also

OSGetShutdownReason

Revision History

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


CONFIDENTIAL