OSSuspendThread

Syntax

#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 operating system maintains a counter 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.

This function sometimes puts the current thread to sleep, so it cannot be called from callback functions. For precautions when calling similar functions, refer to Interrupts and Callback Functions.

Revision History

2007/09/25 Added information on the sleeping status of threads.
2006/03/01 Initial version.