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>OSSleepThread</title>
10</head>
11
12<body>
13
14<h1>OSSleepThread</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>void OSSleepThread(OSThreadQueue* queue);</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><STRONG><EM><CODE>queue</CODE></EM></STRONG></code></b></i></TD>
30<TD width="520">Pointer to the thread queue into which the current thread will be inserted.</TD>
31    </tr>
32</TABLE>
33<h2>Return Values</h2>
34
35<p>None.</p>
36
37<h2>Description</h2>
38
39<p>Suspends the current thread and inserts it into the specified thread <i><b><code>queue</code></b></i>. The thread will remain in sleep until <a href="OSWakeupThread.html"><code>OSWakeupThread()</code></a> is called on this <i><b><code>queue</code></b></i>. </p>
40
41<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>
42
43<h2>See Also</h2>
44
45<p><A href="../toc.html#Thread" target="contents">Thread Synchronization</A>, <A href="../toc.html#ThreadSynchronization" target="contents">Thread Synchronization Functions</A>, <a href="OSInitThreadQueue.html"><code>OSInitThreadQueue</code></a>, <a href="OSWakeupThread.html"><code>OSWakeupThread</code></a>, <a href="../Interrupt/intro.html">Interrupts and Callback Functions</a></p>
46</p>
47
48<h2>Revision History</h2><p></p>
49<p>
502007/09/25 Added information on the sleeping status of threads.<br>2006/03/01 Initial version.<br>
51</p>
52<hr><p>CONFIDENTIAL</p></body>
53</html>