OSEnableHomeButtonMenu

Syntax

#include <cafe/os.h>

BOOL OSEnableHomeButtonMenu(BOOL enable);

Parameters

enable TRUE indicates that the HOME Menu should be enabled and FALSE indicates it should be disabled.

Return Values

Returns TRUE if the enable state was set. Returns FALSE if there is a pending RELEASE_FOREGROUND message in the system message queue and does not change the HOME Menu enable state.

Description

When a process starts, the HOME Menu is disabled until the process starts listening for messages on the system message queue at which point the HOME Menu will be automatically enabled. If a process needs to leave the HOME Menu disabled after it starts listening to the system message queue, it should call OSEnableHomeButtonMenu(FALSE) before calling OSGetSystemMessageQueue.

When the user presses the HOME Button while the HOME Menu is disabled, a message will be put in the system message queue for the process with the data0 set to OS_SYSTEM_MESSAGE_HOMEBUTTON_DENIED.

The application must display the "HOME Menu Disabled" icon when an OS_SYSTEM_MESSAGE_HOMEBUTTON_DENIED message is received. For more information, refer to the Wii U Guidelines.

Do Not Call From

None.

See Also

APP_IN_FOREGROUND
OSIsHomeButtonMenuEnabled
OSGetForegroundBucket
OSGetSystemMessageQueue
OSReleaseForeground
OSSavesDone_ReadyToRelease
OSSendAppSwitchRequest

Revision History

2014/01/21 Terminology change to HOME Menu.
2013/05/08 Automated cleanup pass.
2012/10/11 Added comment about Wii U Guidelines.
2012/08/17 Initial version.


CONFIDENTIAL