OSGetSystemMessageQueue

Syntax

#include <cafe/os.h>

OSMessageQueue *OSGetSystemMessageQueue(void);

Parameters

None.

Return Values

Returns a pointer to the OS system message queue, which can be used in calls to OSReceiveMessage.

Description

This function lets a program retrieve a pointer to its system message queue.

System messages include two well-defined values that appear as the data0 member of an OSMessage:

#define OS_SYSTEM_MESSAGE_DATA0_RELEASE_FOREGROUND   0xFACEBACC
#define OS_SYSTEM_MESSAGE_DATA0_ACQUIRED_FOREGROUND  0xFACEF000

When a RELEASE message is received the program receiving the message should cleanup its use of foreground resources and then call OSReleaseForeground on all three cores.

When an ACQUIRED message is received the program receiving the message can start to use foreground resources again and resume what it was doing before the foreground was released.

Do Not Call From

None.

See Also

System Messages
APP_IN_FOREGROUND
OSGetCallArgs
OSGetForegroundBucket
OSReleaseForeground
OSSavesDone_ReadyToRelease
OSSendAppSwitchRequest
OSReceiveMessage

Revision History

2013/05/08 Automated cleanup pass.
2012/08/20 Remove ALPHA tag.
2012/07/27 Cleanup Pass
2011/08/29 Initial version.


CONFIDENTIAL