OSCancelThread

Syntax

#include <revolution/os.h>

void OSCancelThread(OSThread* thread);

Arguments

thread Pointer to thread to terminate.

Return Values

None.

Description

Stops the specified thread. If in a suspended thread queue, the thread specified by thread is removed from the queue. All mutexes held by this thread will be released.( (All threads waiting to be joined using OSJoinThread will be made runnable.)

If thread has the "detached" attribute set, it will be removed from the run queue immediately.

If the "detached" attribute is not set, the thread specified by thread is removed from the run queue only when all joined threads have started running.

See Also

Thread Functions, Thread Synchronization Functions, OSCreateThread, OSExitThread, OSJoinThread,

Revision History

2008/06/13 Deleted Note.
2007/12/11 Added notes.
2006/03/01 Initial version.


CONFIDENTIAL