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>OSCancelThread</title> 10</head> 11 12<body> 13 14<h1>OSCancelThread</h1> 15 16<h2>Syntax</h2> 17<dl><dd><pre class="construction">#include <revolution/os.h> 18 19void OSCancelThread(OSThread* thread); 20</pre></dd></dl> 21 22<h2>Arguments</h2> 23<TABLE class="arguments" border="1" > 24 <tr> 25<TH>thread</TH> 26<TD>Pointer to thread to terminate.</TD> 27 </tr> 28</TABLE> 29 30<h2>Return Values</h2> 31<p>None.</p> 32 33<h2>Description</h2> 34<p>Stops the specified thread. If in a suspended thread queue, the thread specified by <SPAN class="argument">thread</SPAN> is removed from the queue. All mutexes held by this thread will be released.( (All threads waiting to be joined using <code><a href="OSJoinThread.html">OSJoinThread</a></code> will be made runnable.)</p> 35 36<p>If <SPAN class="argument">thread</SPAN> has the "detached" attribute set, it will be removed from the run queue immediately.</p> 37 38<p>If the "detached" attribute is not set, the thread specified by <SPAN class="argument">thread</SPAN> is removed from the run queue only when all joined threads have started running.</p> 39 40<h2>See Also</h2> 41<P class="reference"> 42<A href="../toc.html#Thread" target="contents">Thread Functions</A>, 43<A href="../toc.html#ThreadSynchronization" target="contents">Thread Synchronization Functions</A>, 44<a href="OSCreateThread.html">OSCreateThread</a>, 45<a href="OSExitThread.html">OSExitThread</a>, 46<a href="OSJoinThread.html">OSJoinThread</a>, 47</p> 48 49<h2>Revision History</h2> 50<P>2008/06/13 Deleted Note. <br>2007/12/11 Added notes. <br>2006/03/01 Initial version.</p> 51 52<hr><p>CONFIDENTIAL</p></body> 53</html>