OSDetachThread

Syntax

#include <cafe/os.h>

void OSDetachThread (OSThread* thread);

Parameters

thread Pointer to the thread for which a detached attribute is to be set.

Return Values

None.

Description

Sets the detached attribute for thread. After a thread ends, that thread is automatically removed from the active thread list. Otherwise, the thread remains on the active thread list until the thread is detached or threads joined to it have ended. Undetached threads enable joining threads to receive the return value of the thread that has ended. This is also useful for debugging because the context of the thread can be analyzed in the debugger after it has terminated.

Do Not Call From

None.

See Also

OSCreateThread
OSJoinThread
OSExitThread

Revision History

2013/05/08 Automated cleanup pass.
2012/08/01 Cleanup pass.
2010/08/30 Initial version.


CONFIDENTIAL