You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

106 lines
12 KiB

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EmbeddedEtcher: os/error.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EmbeddedEtcher
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('error_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">error.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="error_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#ifndef OS_ERROR_H</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#define OS_ERROR_H </span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">//--------------Includes-----------------</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include&quot;<a class="code" href="ostypes_8h.html">ostypes.h</a>&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include&quot;<a class="code" href="ossettings_8h.html">ossettings.h</a>&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">//--------------Preprocessor Hacks-------</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if(DEBUG_MODE == ON)</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define DEBUG_MSG(MSG, ...)\</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor"> osPrintf(&quot;%s:%d: debug: &quot;, __FILE__, __LINE__);\</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor"> osPrintf(MSG, ##__VA_ARGS__)</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="error_8h.html#ad43da790cc069011db9c6f0ef8fea11b"> 26</a></span>&#160;<span class="preprocessor">#define DEBUG_MSG(MSG, ...)</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="error_8h.html#a443fea42d93b53e3569d33e80c5de6c4"> 32</a></span>&#160;<span class="preprocessor">#define THROW_ERROR(ERROR_TYPE)\</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor"> osPrintError(__FILE__, __LINE__, ERROR_TYPE)</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="error_8h.html#a22fc1f25f5e596198d4a773df7762c77"> 38</a></span>&#160;<span class="preprocessor">#define THROW_WARNING(WARNING_TYPE)\</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor"> osPrintWarning(__FILE__, __LINE__, WARNING_TYPE)</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment">//--------------Funtions-----------------</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;uint8_t <a class="code" href="error_8h.html#af770cfb23cba6e7aa7c69aad1bbf968c">osExplainError</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* ifile, <span class="keyword">const</span> uint8_t iline, <span class="keyword">const</span> <a class="code" href="ostypes_8h.html#acd9f76a1fbd8bc9084ff34add637094f">osError_t</a> ierror, <span class="keywordtype">char</span>* iomessage);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;uint8_t <a class="code" href="error_8h.html#a540c46d0a32421cad29354147a02c4ea">osPrintError</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* ifile, <span class="keyword">const</span> <span class="keywordtype">int</span> iline, <span class="keyword">const</span> <a class="code" href="ostypes_8h.html#acd9f76a1fbd8bc9084ff34add637094f">osError_t</a> ierror);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;uint8_t <a class="code" href="error_8h.html#a29238a23e284dd0a6278434447be4682">osExplainWarning</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* ifile, <span class="keyword">const</span> uint8_t iline, <span class="keyword">const</span> <a class="code" href="ostypes_8h.html#a5c976ef3f21f800d03382e5cc640c362">osWarning_t</a> ierror, <span class="keywordtype">char</span>* iomessage);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;uint8_t <a class="code" href="error_8h.html#a8ea68ece7fa351c9c046006749706e26">osPrintWarning</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* ifile, <span class="keyword">const</span> <span class="keywordtype">int</span> iline, <span class="keyword">const</span> <a class="code" href="ostypes_8h.html#a5c976ef3f21f800d03382e5cc640c362">osWarning_t</a> ierror);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="error_8h_html_af770cfb23cba6e7aa7c69aad1bbf968c"><div class="ttname"><a href="error_8h.html#af770cfb23cba6e7aa7c69aad1bbf968c">osExplainError</a></div><div class="ttdeci">uint8_t osExplainError(const char *ifile, const uint8_t iline, const osError_t ierror, char *iomessage)</div><div class="ttdef"><b>Definition:</b> error.c:9</div></div>
<div class="ttc" id="ostypes_8h_html_a5c976ef3f21f800d03382e5cc640c362"><div class="ttname"><a href="ostypes_8h.html#a5c976ef3f21f800d03382e5cc640c362">osWarning_t</a></div><div class="ttdeci">osWarning_t</div><div class="ttdef"><b>Definition:</b> ostypes.h:72</div></div>
<div class="ttc" id="ostypes_8h_html"><div class="ttname"><a href="ostypes_8h.html">ostypes.h</a></div><div class="ttdoc">Different types the operating system uses are defined here. </div></div>
<div class="ttc" id="error_8h_html_a8ea68ece7fa351c9c046006749706e26"><div class="ttname"><a href="error_8h.html#a8ea68ece7fa351c9c046006749706e26">osPrintWarning</a></div><div class="ttdeci">uint8_t osPrintWarning(const char *ifile, const int iline, const osWarning_t ierror)</div><div class="ttdef"><b>Definition:</b> error.c:77</div></div>
<div class="ttc" id="ostypes_8h_html_acd9f76a1fbd8bc9084ff34add637094f"><div class="ttname"><a href="ostypes_8h.html#acd9f76a1fbd8bc9084ff34add637094f">osError_t</a></div><div class="ttdeci">osError_t</div><div class="ttdef"><b>Definition:</b> ostypes.h:56</div></div>
<div class="ttc" id="error_8h_html_a29238a23e284dd0a6278434447be4682"><div class="ttname"><a href="error_8h.html#a29238a23e284dd0a6278434447be4682">osExplainWarning</a></div><div class="ttdeci">uint8_t osExplainWarning(const char *ifile, const uint8_t iline, const osWarning_t ierror, char *iomessage)</div><div class="ttdef"><b>Definition:</b> error.c:57</div></div>
<div class="ttc" id="ossettings_8h_html"><div class="ttname"><a href="ossettings_8h.html">ossettings.h</a></div><div class="ttdoc">File where all settings take place. </div></div>
<div class="ttc" id="error_8h_html_a540c46d0a32421cad29354147a02c4ea"><div class="ttname"><a href="error_8h.html#a540c46d0a32421cad29354147a02c4ea">osPrintError</a></div><div class="ttdeci">uint8_t osPrintError(const char *ifile, const int iline, const osError_t ierror)</div><div class="ttdef"><b>Definition:</b> error.c:46</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_8b7cb6c889a10e2a101a7e90c854ca4d.html">os</a></li><li class="navelem"><a class="el" href="error_8h.html">error.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>