OSJoinThread

C Specification

#include <revolution/os.h>

BOOL OSJoinThread (OSThread* thread, void** val);

Arguments

`thread`	Pointer to thread to join.
`val`	Pointer to a void pointer in which the thread's exit value is copied. *`val`* will be assigned `(void*) -1` if the thread is canceled using `OSCancelThread`. Specify `NULL` if the thread's exit value is unnecessary.

Return Values

Returns TRUE if the specified thread does not have the detached attribute and has ended normally. Otherwise, returns FALSE.

Description

If the specified thread does not have the detached attribute (see the OSDetachThread function), the OSJoinThread function will wait until the specified thread ends, and then generate information about the ended thread.

Multiple threads can't wait for the same thread to end. Success is guaranteed for only one thread; FALSE is returned for all other threads.

Revision History