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<h2>Syntax</h2>
17<dl><dd><pre class="construction">#include &lt;revolution/os.h&gt;
18
19void OSSleepThread(OSThreadQueue* queue);
20</pre></dd></dl>
21
22<h2>Arguments</h2>
23<TABLE class="arguments" border="1" >
24  <tr>
25<TH><STRONG><EM><CODE>queue</CODE></EM></STRONG></TH>
26<TD>Pointer to the thread queue into which the current thread will be inserted.</TD>
27  </tr>
28</TABLE>
29
30<h2>Return Values</h2>
31<p>None.</p>
32
33<h2>Description</h2>
34<p>Suspends the current thread and inserts it into the thread queue specified by <SPAN class="argument">queue</SPAN>. The thread will remain suspended until the <code>OSWakeupThread</code> function is called with <SPAN class="argument">queue</SPAN> as an argument.</p>
35
36<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>
37
38<h2>See Also</h2>
39<P class="reference">
40<A href="../toc.html#Thread" target="contents">Thread Functions</A>,
41<A href="../toc.html#ThreadSynchronization" target="contents">Thread Synchronization Functions</A>,
42<a href="OSInitThreadQueue.html">OSInitThreadQueue</a>,
43<a href="OSWakeupThread.html">OSWakeupThread</a>
44<a href="../Interrupt/intro.html">Interrupts and Callback Functions</a>
45</p>
46
47<h2>Revision History</h2>
48<P>
492007/09/25 Added information on the sleeping status of threads.<br>2006/03/01 Initial version.<br>
50</p>
51
52<hr><p>CONFIDENTIAL</p></body>
53</html>