OSLoadCoroutine DEPRECATED

Syntax

#include <cafe/os.h>

void OSLoadCoroutine(OSCoroutine *coroutine, void *retval);

Parameters

coroutine Pointer to OSCoroutine to resume.
retval Value to return when resuming from OSSaveCoroutine.

Return Values

None; OSLoadCoroutine never returns.

Description

NOTE:
Although the Wii U coroutine API is not considered fully deprecated, it should not be used in new applications; threads should be used instead.

OSLoadCoroutine switches to a coroutine that was originally saved or initialized by OSSaveCoroutine, OSSwitchCoroutine, or OSInitCoroutine. You may pass a non-0 argument to the next coroutine with the retval parameter. If the next coroutine was originally saved by OSSaveCoroutine, then the resumed OSSaveCoroutine will return this nonzero value.

Do Not Call From

Deprecated Do not call this function in new code.
Multiple threads This function is not thread-safe.
Callbacks Do not call this function from any callback function.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.
Multiple Cores Do not call this function from more than one Core.

See Also

Coroutine Overview
OSInitCoroutine
OSSaveCoroutine
OSSwitchCoroutine

Revision History

2013/08/02 Clarify coroutine usage.
2013/05/08 Automated cleanup pass.
2012/08/01 Cleanup Pass.
2011/03/15 Initial version.


CONFIDENTIAL