OSSuspendThread

C Specification

#include <revolution/os.h>
s32 OSSuspendThread (OSThread* thread);

Arguments

thread Pointer to thread to suspend.

Return Values

The previous suspend counter of the thread. The thread is suspended if the counter is greater than zero.

Description

Suspends the specified thread (incremental).

The OS keeps track of the number of times the OSSuspendThread function has been called. Calling the OSResumeThread function will decrement that counter. While the counter is greater than zero, the thread will not be scheduled to execute.

See Also

Thread Synchronization, Thread Synchronization Functions, OSIsThreadSuspended,   OSResumeThread

Revision History

03/01/2006 Initial version.