OSGetCallArgs

Syntax

#include <cafe/os.h>

BOOL OSGetCallArgs(UPID *apRetCaller, u8 *apBuffer, u32 aBufferBytes);

Parameters

apRetCaller Pointer to UPID variable in which to store the caller's unique process ID (UPID). This argument may not be NULL.
apBuffer Buffer in which to return the arguments from the last caller.
aBufferBytes Size in bytes of the buffer pointed to by apBuffer argument.

Return Values

Returns TRUE on success (a previous call was made), or FALSE for failure.

Description

A process may be "switched to" via the function call OSSendAppSwitchRequest.

When a switch is made and the process receives the foreground, it may call this function to retrieve the arguments that were passed to it by the "calling" process. The arguments from one switch to a process remain the same and accessible via this function call until a subsequent switch to the process is made.

Do Not Call From

None.

See Also

APP_IN_FOREGROUND
OSGetForegroundBucket
OSGetSystemMessageQueue
OSReleaseForeground
OSSavesDone_ReadyToRelease
OSSendAppSwitchRequest

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