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 name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.1.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<TITLE>OS_IsRunOnDebugger</TITLE>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</HEAD>
10<BODY>
11<H1 align="left">OS_IsRunOnDebugger <IMG src="../../image/NTR.gif" align="middle"><IMG src="../../image/TWL.gif" align="middle"></H1>
12<H2>Syntax</H2>
13<DL>
14  <DD><CODE>#include &lt;nitro/os.h&gt;</CODE><BR> <BR> <CODE>BOOL OS_IsRunOnEmulator( void );</CODE>
15</DL>
16<H2>Arguments</H2>
17<P>None.</P>
18<H2>Return Values</H2>
19<P>If the program is running on IS-NITRO-DEBUGGER or IS-TWL-DEBUGGER, returns <CODE>TRUE</CODE>. Otherwise, returns <CODE>FALSE</CODE>.</P>
20<H2>Description</H2>
21<P>Checks whether the program is running on either IS-NITRO-DEBUGGER or IS-TWL-DEBUGGER.</P>
22<P>Because this is a debugging function, it always returns <code>FALSE</code> in the FINALROM version of the library.</P>
23<H3>Similar Functions</H3>
24<P>The <A href="OS_IsRunOnEmulator.html"><CODE>OS_IsRunOnEmulator</CODE></A> function is also used for finding out the operating environment. It can find out whether the application is running on the Ensata NITRO Software Emulator.</P>
25<H3>Actual Values Due to the Environment or Build</H3>
26<P>The table below shows the differences in the values returned by the <A href="OS_IsRunOnDebugger.html"><CODE>OS_IsRunOnDebugger</CODE></A> and <A href="OS_IsRunOnEmulator.html"><CODE>OS_IsRunOnEmulator</CODE></A> functions due to the operating environment.<BR>
27</P>
28<TABLE border="1">
29  <TBODY>
30    <TR>
31      <TH colspan="4" style="background-color:#304040;"><FONT color="#ffffff">For NITRO Mode</FONT></TH>
32    </TR>
33    <TR>
34      <TH>Operating Environment</TH>
35      <TH>Build</TH>
36      <TH>Value of <CODE>OS_IsRunOnDebugger</CODE></TH>
37      <TH>Value of <CODE>OS_IsRunOnEmulator</CODE></TH>
38    </TR>
39    <TR>
40      <TD>Actual DS unit</TD>
41      <TD>DEBUG<BR> RELEASE<BR> FINALROM</TD>
42      <TD><B>FALSE</B></TD>
43      <TD><B>FALSE</B></TD>
44    </TR>
45    <TR>
46      <TD>Actual TWL unit</TD>
47      <TD>DEBUG<BR> RELEASE<BR> FINALROM</TD>
48      <TD><B>FALSE</B></TD>
49      <TD><B>FALSE</B></TD>
50    </TR>
51    <TR>
52      <TD rowspan="2">IS-NITRO-DEBUGGER</TD>
53      <TD>DEBUG<BR> RELEASE</TD>
54      <TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
55      <TD><B>FALSE</B></TD>
56    </TR>
57    <TR>
58      <TD>FINALROM</TD>
59      <TD><B>FALSE</B></TD>
60      <TD><B>FALSE</B></TD>
61    </TR>
62    <TR>
63      <TD rowspan="2">ENSATA EMULATOR</TD>
64      <TD>DEBUG<BR> RELEASE</TD>
65      <TD><B>FALSE</B></TD>
66      <TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
67    </TR>
68    <TR>
69      <TD>FINALROM</TD>
70      <TD><B>FALSE</B></TD>
71      <TD><B>FALSE</B></TD>
72    </TR>
73    <TR>
74      <TD rowspan="2">IS-TWL-DEBUGGER<BR>(For standard development: ARM9)</TD>
75      <TD>DEBUG<BR> RELEASE</TD>
76      <TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
77      <TD><B>FALSE</B></TD>
78    </TR>
79    <TR>
80      <TD>FINALROM</TD>
81      <TD><B>FALSE</B></TD>
82      <TD><B>FALSE</B></TD>
83    </TR>
84    <TR>
85      <TD rowspan="2">IS-TWL-DEBUGGER<BR>(For component development<BR>ARM9 + ARM7)</TD>
86      <TD>DEBUG<BR> RELEASE</TD>
87      <TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
88      <TD><B>FALSE</B></TD>
89    </TR>
90    <TR>
91      <TD>FINALROM</TD>
92      <TD><B>FALSE</B></TD>
93      <TD><B>FALSE</B></TD>
94    </TR>
95    <TR>
96      <TH colspan="4" style="background-color:#304040;"><FONT color="#ffffff">For TWL Mode</FONT></TH>
97    </TR>
98    <TR>
99      <TH>Operating Environment</TH>
100      <TH>Build</TH>
101      <TH>Value of <CODE>OS_IsRunOnDebugger</CODE></TH>
102      <TH>Value of <CODE>OS_IsRunOnEmulator</CODE></TH>
103    </TR>
104    <TR>
105      <TD>Actual TWL unit</TD>
106      <TD>DEBUG<BR> RELEASE<BR> FINALROM</TD>
107      <TD><B>FALSE</B></TD>
108      <TD><B>FALSE</B></TD>
109    </TR>
110    <TR>
111      <TD rowspan="2">IS-TWL-DEBUGGER<BR>(For standard development: ARM9)</TD>
112      <TD>DEBUG<BR> RELEASE</TD>
113      <TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
114      <TD><B>FALSE</B></TD>
115    </TR>
116    <TR>
117      <TD>FINALROM</TD>
118      <TD><B>FALSE</B></TD>
119      <TD><B>FALSE</B></TD>
120    </TR>
121    <TR>
122      <TD rowspan="2">IS-TWL-DEBUGGER<BR>(For component development<BR>ARM9 + ARM7)</TD>
123      <TD>DEBUG<BR> RELEASE</TD>
124      <TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
125      <TD><B>FALSE</B></TD>
126    </TR>
127    <TR>
128      <TD>FINALROM</TD>
129      <TD><B>FALSE</B></TD>
130      <TD><B>FALSE</B></TD>
131    </TR>
132  </TBODY>
133</TABLE>
134<H2>Internal Operation</H2>
135<P>Makes a decision based on the logical sum of the the return value of the <A href="OS_GetConsoleType.html"><CODE>OS_GetConsoleType</CODE></A> function and the <CODE>OS_CONSOLE_ISDEBUGGER</CODE> and <CODE>OS_CONSOLE_TWLDEBUGGER</CODE> bits.</P>
136<H2>See Also</H2>
137<P><A href="OS_IsRunOnEmulator.html"><CODE>OS_IsRunOnEmulator</CODE></A><BR> <A href="OS_GetConsoleType.html"><CODE>OS_GetConsoleType</CODE></A></P>
138<H2>Revision History</H2>
139<P>2008/04/15 Added tables.<br> 2007/11/05 Initial version.</P>
140<hr><p>CONFIDENTIAL</p></body>
141</HTML>