OSCancelThread

C Specification

#include <revolution/os.h>

void OSCancelThread (OSThread* thread);

Arguments

thread Pointer to thread to terminate.

Return Values

None.

Description

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

If the detached attribute is set for the thread specified by thread, the thread will be removed immediately from the execution queue.

If the detached attribute is not set, the thread specified by thread will be removed from the execution queue only when all joined threads start executing.

Revision History