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.
421 lines
18 KiB
421 lines
18 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 File Reference</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.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="summary">
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">error.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Error logging functionalities of the operating system.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="ostypes_8h_source.html">ostypes.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="ossettings_8h_source.html">ossettings.h</a>"</code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for error.h:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="error_8h__incl.png" border="0" usemap="#os_2error_8h" alt=""/></div>
|
|
<map name="os_2error_8h" id="os_2error_8h">
|
|
<area shape="rect" id="node2" href="ostypes_8h.html" title="Different types the operating system uses are defined here. " alt="" coords="25,80,104,107"/>
|
|
<area shape="rect" id="node4" href="ossettings_8h.html" title="File where all settings take place. " alt="" coords="95,155,189,181"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
<p><a href="error_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ad43da790cc069011db9c6f0ef8fea11b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#ad43da790cc069011db9c6f0ef8fea11b">DEBUG_MSG</a>(MSG, ...)</td></tr>
|
|
<tr class="separator:ad43da790cc069011db9c6f0ef8fea11b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a443fea42d93b53e3569d33e80c5de6c4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a443fea42d93b53e3569d33e80c5de6c4">THROW_ERROR</a>(ERROR_TYPE)   <a class="el" href="error_8h.html#a540c46d0a32421cad29354147a02c4ea">osPrintError</a>(__FILE__, __LINE__, ERROR_TYPE)</td></tr>
|
|
<tr class="separator:a443fea42d93b53e3569d33e80c5de6c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22fc1f25f5e596198d4a773df7762c77"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a22fc1f25f5e596198d4a773df7762c77">THROW_WARNING</a>(WARNING_TYPE)   <a class="el" href="error_8h.html#a8ea68ece7fa351c9c046006749706e26">osPrintWarning</a>(__FILE__, __LINE__, WARNING_TYPE)</td></tr>
|
|
<tr class="separator:a22fc1f25f5e596198d4a773df7762c77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:af770cfb23cba6e7aa7c69aad1bbf968c"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#af770cfb23cba6e7aa7c69aad1bbf968c">osExplainError</a> (const char *ifile, const uint8_t iline, const <a class="el" href="ostypes_8h.html#acd9f76a1fbd8bc9084ff34add637094f">osError_t</a> ierror, char *iomessage)</td></tr>
|
|
<tr class="separator:af770cfb23cba6e7aa7c69aad1bbf968c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a540c46d0a32421cad29354147a02c4ea"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a540c46d0a32421cad29354147a02c4ea">osPrintError</a> (const char *ifile, const int iline, const <a class="el" href="ostypes_8h.html#acd9f76a1fbd8bc9084ff34add637094f">osError_t</a> ierror)</td></tr>
|
|
<tr class="separator:a540c46d0a32421cad29354147a02c4ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a29238a23e284dd0a6278434447be4682"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a29238a23e284dd0a6278434447be4682">osExplainWarning</a> (const char *ifile, const uint8_t iline, const <a class="el" href="ostypes_8h.html#a5c976ef3f21f800d03382e5cc640c362">osWarning_t</a> ierror, char *iomessage)</td></tr>
|
|
<tr class="separator:a29238a23e284dd0a6278434447be4682"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ea68ece7fa351c9c046006749706e26"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a8ea68ece7fa351c9c046006749706e26">osPrintWarning</a> (const char *ifile, const int iline, const <a class="el" href="ostypes_8h.html#a5c976ef3f21f800d03382e5cc640c362">osWarning_t</a> ierror)</td></tr>
|
|
<tr class="separator:a8ea68ece7fa351c9c046006749706e26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Error logging functionalities of the operating system. </p>
|
|
<dl class="section author"><dt>Author</dt><dd>Maximilian Stiefel </dd></dl>
|
|
<dl class="section date"><dt>Date</dt><dd>8 Jan 2018 </dd></dl>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="ad43da790cc069011db9c6f0ef8fea11b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad43da790cc069011db9c6f0ef8fea11b">◆ </a></span>DEBUG_MSG</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define DEBUG_MSG</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">MSG, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>...</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Create smart debug messages, which are disable if DEBUG is not defined. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a443fea42d93b53e3569d33e80c5de6c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a443fea42d93b53e3569d33e80c5de6c4">◆ </a></span>THROW_ERROR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define THROW_ERROR</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ERROR_TYPE</td><td>)</td>
|
|
<td>   <a class="el" href="error_8h.html#a540c46d0a32421cad29354147a02c4ea">osPrintError</a>(__FILE__, __LINE__, ERROR_TYPE)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Throws an error given an error type. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a22fc1f25f5e596198d4a773df7762c77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a22fc1f25f5e596198d4a773df7762c77">◆ </a></span>THROW_WARNING</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define THROW_WARNING</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">WARNING_TYPE</td><td>)</td>
|
|
<td>   <a class="el" href="error_8h.html#a8ea68ece7fa351c9c046006749706e26">osPrintWarning</a>(__FILE__, __LINE__, WARNING_TYPE)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Throws a warning given a warning type. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="af770cfb23cba6e7aa7c69aad1bbf968c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af770cfb23cba6e7aa7c69aad1bbf968c">◆ </a></span>osExplainError()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t osExplainError </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>ifile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>iline</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="ostypes_8h.html#acd9f76a1fbd8bc9084ff34add637094f">osError_t</a> </td>
|
|
<td class="paramname"><em>ierror</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>iomessage</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Creating a error message string from inter alia an error code.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ifile</td><td>Filename where error occurs. </td></tr>
|
|
<tr><td class="paramname">iline</td><td>Line where error occurs. </td></tr>
|
|
<tr><td class="paramname">ierror</td><td>Error code. </td></tr>
|
|
<tr><td class="paramname">message</td><td>Message related to the error. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">1</td><td>(SUCCESS) or 0 (FAILURE). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a29238a23e284dd0a6278434447be4682"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a29238a23e284dd0a6278434447be4682">◆ </a></span>osExplainWarning()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t osExplainWarning </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>ifile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>iline</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="ostypes_8h.html#a5c976ef3f21f800d03382e5cc640c362">osWarning_t</a> </td>
|
|
<td class="paramname"><em>ierror</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>iomessage</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Creating a warning message string from inter alia a warning code.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ifile</td><td>Filename where warning occurs. </td></tr>
|
|
<tr><td class="paramname">iline</td><td>Line where warning occurs. </td></tr>
|
|
<tr><td class="paramname">ierror</td><td>Warning code. </td></tr>
|
|
<tr><td class="paramname">message</td><td>Message related to the warning. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">1</td><td>(SUCCESS) or 0 (FAILURE). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a540c46d0a32421cad29354147a02c4ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a540c46d0a32421cad29354147a02c4ea">◆ </a></span>osPrintError()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t osPrintError </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>ifile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>iline</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="ostypes_8h.html#acd9f76a1fbd8bc9084ff34add637094f">osError_t</a> </td>
|
|
<td class="paramname"><em>ierror</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Print error. This is where the error output can be redirected (later).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ifile</td><td>Filename where error occurs. </td></tr>
|
|
<tr><td class="paramname">iline</td><td>Line where error occurs. </td></tr>
|
|
<tr><td class="paramname">ierror</td><td>Error code. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">1</td><td>(SUCCESS) or 0 (FAILURE). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8ea68ece7fa351c9c046006749706e26"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ea68ece7fa351c9c046006749706e26">◆ </a></span>osPrintWarning()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t osPrintWarning </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>ifile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>iline</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="ostypes_8h.html#a5c976ef3f21f800d03382e5cc640c362">osWarning_t</a> </td>
|
|
<td class="paramname"><em>ierror</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Print warning. This is where the warning output can be redirected (later).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ifile</td><td>Filename where warning occurs. </td></tr>
|
|
<tr><td class="paramname">iline</td><td>Line where warning occurs. </td></tr>
|
|
<tr><td class="paramname">ierror</td><td>Warning code. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">1</td><td>(SUCCESS) or 0 (FAILURE). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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>
|
|
|