OSSendAppSwitchRequest DEPRECATED

Syntax

#include <cafe/os.h>

BOOL OSSendAppSwitchRequest(UPID aProcId, void *apArgs, u32 aArgsBytes);

Parameters

aProcId UPID of process you wish to switch to. For a list of available processes, including the Internet browser, see the types.h header file.
apArgs Pointer to arguments to send to the process that it can retrieve when it acquires the foreground.
aArgsBytes Size of the arguments pointed to by the apArgs argument.

Return Values

Returns TRUE if the request to switch was made successfully, or FALSE if there was an error.

Description

This function is used to "switch to" or "call" another process, such as the Internet browser, the e-manual Viewer, or the HOME Menu. When this function call is successfully issued, a message to release the foreground will appear in the application's system message queue. When the foreground is released, the process being called will acquire the foreground and can then receive the arguments via the OSGetCallArgs function call. Typically when the process being switched to has completed its work, it will switch back to the calling process with the results as the argument of the switch.

NOTE:
This function has been deprecated in favor of the SYSAPP library API.

Do Not Call From

Deprecated Do not call this function in new code.
Multiple threads This function is not thread-safe.

See Also

APP_IN_FOREGROUND
OSGetCallArgs
OSGetForegroundBucket
OSGetSystemMessageQueue
OSSavesDone_ReadyToRelease
OSReleaseForeground

Revision History

2014/01/21 Terminology change to HOME Menu.
2013/05/08 Automated cleanup pass.
2012/08/17 Deprecate this API.
2012/07/27 Cleanup Pass
2012/05/25 Match actual header.
2011/08/29 Initial version.


CONFIDENTIAL