1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="Microsoft FrontPage 5.0">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
9<title>OSSuspendThread</title>
10</head>
11
12<body>
13
14<h1>OSSuspendThread</h1>
15
16
17<h2>C Specification</h2>
18
19<dl>
20  <dd><pre><code>#include &lt;revolution/os.h&gt;</code></pre>
21  </dd>
22  <dd><pre><code>s32 OSSuspendThread(OSThread* thread);</code></pre>
23  </dd>
24</dl>
25
26<h2>Arguments</h2>
27<TABLE border="1" cellpadding="3" cellspacing="0.1">
28  <tr>
29<TD width="120" bgcolor="#ffffe8"><i><b><code>thread</code></b></i></TD>
30<TD width="520">Pointer to thread to suspend.</TD>
31    </tr>
32</TABLE>
33<h2>Return Values</h2>
34
35<p>The previous suspend counter of the thread. The thread is suspended if the counter is greater than zero.</p>
36
37<h2>Description</h2>
38
39<p>Suspends the specified thread (incremental).</p>
40
41<p>The OS keeps track of the number of times the <code>OSSuspendThread</code> function has been called.&nbsp;Calling the <a href="OSResumeThread.html"><code>OSResumeThread</code></a> function will decrement that counter.&nbsp;While the counter is greater than zero, the thread will not be scheduled to execute.</p>
42
43<p>This function may put the current thread to sleep. For precautions when calling similar functions, refer to <a href="../Interrupt/intro.html">Interrupts and Callback Functions</a>.</p>
44
45<h2>See Also</h2>
46
47<p><A href="../toc.html#Thread" target="contents">Thread Synchronization</A>, <A href="../toc.html#ThreadSynchronization" target="contents">Thread Synchronization Functions</A>, <a href="OSIsThreadSuspended.html"><code>OSIsThreadSuspended</code></a>, <a href="OSResumeThread.html"><code>OSResumeThread</code></a>, <a href="../Interrupt/intro.html">Interrupts and Callback Functions</a></p>
48
49<h2>Revision History</h2><p></p>
50<p>
512007/09/25 Added information on the sleeping status of threads.<br>2006/03/01 Initial version.<br>
52</p>
53<hr><p>CONFIDENTIAL</p></body>
54</html>