Exit Reason

API for the application to notify the system of the reason it will exit. More...

Collaboration diagram for Exit Reason:

Typedefs
typedef enum AppExitReason	AppExitReason

Enumerations
enum	AppExitReason { APP_EXIT_NOT_SPECIFIED = 0, APP_EXIT_ACTION_PERFORMED_SUCCESSFULLY, NUM_EXIT_REASONS }

Functions
void	exit_reason_set (AppExitReason exit_reason)

Detailed Description

API for the application to notify the system of the reason it will exit.

If the application has not specified an exit reason before it exits, then the exit reason will default to APP_EXIT_NOT_SPECIFIED.

Only an application can set its exit reason. The system will not modify it.

Typedef Documentation

AppExitReason

typedef enum AppExitReason AppExitReason

AppExitReason is used to notify the system of the reason of an application exiting, which may affect the part of the system UI that is presented after the application terminates.

Enumeration Type Documentation

AppExitReason

enum AppExitReason

AppExitReason is used to notify the system of the reason of an application exiting, which may affect the part of the system UI that is presented after the application terminates.

Enumerator
APP_EXIT_NOT_SPECIFIED	Exit reason not specified.
APP_EXIT_ACTION_PERFORMED_SUCCESSFULLY	Application performed an action when it exited.
NUM_EXIT_REASONS	Number of AppExitReason options.

Function Documentation

exit_reason_set()

void exit_reason_set

(

AppExitReason

exit_reason

)

Set the app exit reason to a new reason.

Parameters

reason

The new app exit reason