OSCancelThread

Syntax

#include <cafe/os.h>
 
void OSCancelThread (OSThread* thread);

Parameters

thread Pointer to the thread to terminate.

Return Values

None.

Description

Cancels the specified thread. Canceling occurs when the specified thread reaches specific points in its execution. The specified thread can be canceled at the following points. Such points are called a cancellation point.

NOTE:
Canceling will not occur as long as the thread is blocking. For example, the thread waits for the mutex and OSSpinLock.

Perform canceling under the following conditions:

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.

Confirm the completion of the termination by OSIsThreadTerminated or OSJoinThread.

Do Not Call From

None.

See Also

OSIsThreadTerminated
OSJoinThread
OSTestThreadCancel
OSSetThreadCancelState

Revision History

2013-05-08 Automated cleanup pass.
2012-08-01 Cleanup pass.
2011-11-25 Modified the specification.
2011-10-14 Initial version.


CONFIDENTIAL