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>OSDisableScheduler</title>
10</head>
11
12<body>
13
14<h1>OSDisableScheduler</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 OSDisableScheduler (void);</code></pre>
23  </dd>
24</dl>
25
26<h2>Arguments</h2>
27
28<p>None.</p>
29
30<h2>Return Values</h2>
31
32<p>The counter value before the scheduler suspends (suspends if value &gt; 0).</p>
33
34<h2>Description</h2>
35
36<p>Suspends thread rescheduling (incremental). Interrupts must be disabled when this function is called.</p>
37
38<p>The scheduler counts the number of times the <a href="OSDisableScheduler.html"><code>OSDisableScheduler</code></a> function has been called.&nbsp;The <code>OSEnableScheduler</code> function decrements the counter. Scheduling is enabled only when the counter is &#x2264; 0.</p>
39
40
41
42<h2>See Also</h2>
43
44<p><a href="../toc.html#Thread" target="contents">Thread Synchronization</a>, <a href="../toc.html#ThreadSynchronization" target="contents">Thread Synchronization Functions</a>,<a href="OSEnableScheduler.html"><code>OSEnableScheduler</code></a></p>
45
46<h2>Revision History</h2><p></p>
47
48<P>2006/03/01 Initial version.</p>
49
50<hr>
51<P>CONFIDENTIAL</p>
52</BODY>
53</HTML>