1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<TITLE>NWC24SuspendScheduler</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24SuspendScheduler</H1>
11
12<H2>Syntax</H2>
13<DL>
14  <DD><PRE><CODE>#include &lt;revolution/nwc24.h&gt;</CODE></PRE>
15  <DD><PRE><CODE>s32 NWC24SuspendScheduler( void );</CODE></PRE>
16</DL>
17
18<H2>Description</H2>
19<P>
20Temporarily suspends the auto-scheduler.<BR>Blocks and waits until the auto-scheduler is paused.<BR>
21</P>
22<P>
23If the automatic scheduler is already in a suspended state, the suspend counter maintained within the library will be incremented.<BR> To release the suspended state, this must be matched by an equal number of calls to the <A href="NWC24ResumeScheduler.html"><CODE>NWC24ResumeScheduler</CODE></A> function.
24</P>
25
26<H2>Arguments</H2>
27<P>
28None.
29</P>
30
31<h2>Return Values</h2>
32<P>
33Returns the suspend counter from before the process' start.<BR><BR> When 0 is returned, it indicates that the auto-schedule was in an executable state before the process began.<BR> When a positive number is returned. it indicates it was paused before the process began. <BR>One of the following is returned when the process fails:</P>
34<P>
35<code>NWC24_ERR_FATAL</code>: fatal error.<BR> <code>NWC24_ERR_INTERNAL_IPC</code>: problem with internal process.<BR> <code>NWC24_ERR_INPROGRESS</code>: scheduler has not started.<BR> <code>NWC24_ERR_MUTEX</code>: there is context indicating another call to the scheduler API and such.<BR>
36</P>
37
38
39<H2>See Also</H2>
40<P>
41<A href="NWC24TrySuspendScheduler.html"><CODE>NWC24TrySuspendScheduler</CODE></A>, <A href="NWC24ResumeScheduler.html"><CODE>NWC24ResumeScheduler</CODE></A>
42</P>
43
44<H2>Revision History</H2>
45<P>
462007/12/13 Described internal counter operations. <BR>2006/09/01 Initial version.
47</P>
48
49<hr><p>CONFIDENTIAL</p></body>
50</HTML>