EVOLUTION-MANAGER
Edit File: group___error.html
<!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.5"/> <title>ALSA project - the C library reference: Error handling</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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="padding-left: 0.5em;"> <div id="projectname">ALSA project - the C library reference </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> | <a href="#var-members">Variables</a> </div> <div class="headertitle"> <div class="title">Error handling</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:ga4e74ed65daac8e1737b7ec7b38d11ab4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#ga4e74ed65daac8e1737b7ec7b38d11ab4">SND_ERROR_BEGIN</a>   500000</td></tr> <tr class="separator:ga4e74ed65daac8e1737b7ec7b38d11ab4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae24d4fe06c0a7478ebdaeeeca55d34c5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#gae24d4fe06c0a7478ebdaeeeca55d34c5">SND_ERROR_INCOMPATIBLE_VERSION</a>   (<a class="el" href="group___error.html#ga4e74ed65daac8e1737b7ec7b38d11ab4">SND_ERROR_BEGIN</a>+0)</td></tr> <tr class="separator:gae24d4fe06c0a7478ebdaeeeca55d34c5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga07b06f3c54db1c1d382e02b59b4fb652"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#ga07b06f3c54db1c1d382e02b59b4fb652">SND_ERROR_ALISP_NIL</a>   (<a class="el" href="group___error.html#ga4e74ed65daac8e1737b7ec7b38d11ab4">SND_ERROR_BEGIN</a>+1)</td></tr> <tr class="separator:ga07b06f3c54db1c1d382e02b59b4fb652"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga281420eb1344fe9f01d67d20c92457f0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#ga281420eb1344fe9f01d67d20c92457f0">SNDERR</a>(args...)   <a class="el" href="group___error.html#gad6a605072dcc056de5f86d67687d90a6">snd_lib_error</a>(__FILE__, __LINE__, __FUNCTION__, 0, ##args)</td></tr> <tr class="separator:ga281420eb1344fe9f01d67d20c92457f0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6a6d50d5d5c51d971732e9925a226435"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#ga6a6d50d5d5c51d971732e9925a226435">SYSERR</a>(args...)   <a class="el" href="group___error.html#gad6a605072dcc056de5f86d67687d90a6">snd_lib_error</a>(__FILE__, __LINE__, __FUNCTION__, errno, ##args)</td></tr> <tr class="separator:ga6a6d50d5d5c51d971732e9925a226435"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:gac24b8de276929202a3e3d0b45c20b6c1"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#gac24b8de276929202a3e3d0b45c20b6c1">snd_lib_error_handler_t</a> )(const char *file, int line, const char *function, int err, const char *fmt,...)</td></tr> <tr class="memdesc:gac24b8de276929202a3e3d0b45c20b6c1"><td class="mdescLeft"> </td><td class="mdescRight">Error handler callback. <a href="#gac24b8de276929202a3e3d0b45c20b6c1">More...</a><br/></td></tr> <tr class="separator:gac24b8de276929202a3e3d0b45c20b6c1"><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:ga182bbadf2349e11602bc531e8cf22f7e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#ga182bbadf2349e11602bc531e8cf22f7e">snd_strerror</a> (int errnum)</td></tr> <tr class="memdesc:ga182bbadf2349e11602bc531e8cf22f7e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the message for an error code. <a href="#ga182bbadf2349e11602bc531e8cf22f7e">More...</a><br/></td></tr> <tr class="separator:ga182bbadf2349e11602bc531e8cf22f7e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6ba1f0aa6c6bc5d335ab297d6019cb03"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#ga6ba1f0aa6c6bc5d335ab297d6019cb03">snd_lib_error_set_handler</a> (<a class="el" href="group___error.html#gac24b8de276929202a3e3d0b45c20b6c1">snd_lib_error_handler_t</a> handler)</td></tr> <tr class="memdesc:ga6ba1f0aa6c6bc5d335ab297d6019cb03"><td class="mdescLeft"> </td><td class="mdescRight">Sets the error handler. <a href="#ga6ba1f0aa6c6bc5d335ab297d6019cb03">More...</a><br/></td></tr> <tr class="separator:ga6ba1f0aa6c6bc5d335ab297d6019cb03"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> Variables</h2></td></tr> <tr class="memitem:gad6a605072dcc056de5f86d67687d90a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error.html#gac24b8de276929202a3e3d0b45c20b6c1">snd_lib_error_handler_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#gad6a605072dcc056de5f86d67687d90a6">snd_lib_error</a></td></tr> <tr class="separator:gad6a605072dcc056de5f86d67687d90a6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad6a605072dcc056de5f86d67687d90a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error.html#gac24b8de276929202a3e3d0b45c20b6c1">snd_lib_error_handler_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#gad6a605072dcc056de5f86d67687d90a6">snd_lib_error</a> = snd_lib_error_default</td></tr> <tr class="separator:gad6a605072dcc056de5f86d67687d90a6"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Error handling macros and functions. </p> <h2 class="groupheader">Macro Definition Documentation</h2> <a class="anchor" id="ga07b06f3c54db1c1d382e02b59b4fb652"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SND_ERROR_ALISP_NIL   (<a class="el" href="group___error.html#ga4e74ed65daac8e1737b7ec7b38d11ab4">SND_ERROR_BEGIN</a>+1)</td> </tr> </table> </div><div class="memdoc"> <p>Lisp encountered an error during acall. </p> </div> </div> <a class="anchor" id="ga4e74ed65daac8e1737b7ec7b38d11ab4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SND_ERROR_BEGIN   500000</td> </tr> </table> </div><div class="memdoc"> <p>Lower boundary of sound error codes. </p> </div> </div> <a class="anchor" id="gae24d4fe06c0a7478ebdaeeeca55d34c5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SND_ERROR_INCOMPATIBLE_VERSION   (<a class="el" href="group___error.html#ga4e74ed65daac8e1737b7ec7b38d11ab4">SND_ERROR_BEGIN</a>+0)</td> </tr> </table> </div><div class="memdoc"> <p>Kernel/library protocols are not compatible. </p> </div> </div> <a class="anchor" id="ga281420eb1344fe9f01d67d20c92457f0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SNDERR</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">args...</td><td>)</td> <td>   <a class="el" href="group___error.html#gad6a605072dcc056de5f86d67687d90a6">snd_lib_error</a>(__FILE__, __LINE__, __FUNCTION__, 0, ##args)</td> </tr> </table> </div><div class="memdoc"> <p>Shows a sound error message. </p> </div> </div> <a class="anchor" id="ga6a6d50d5d5c51d971732e9925a226435"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SYSERR</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">args...</td><td>)</td> <td>   <a class="el" href="group___error.html#gad6a605072dcc056de5f86d67687d90a6">snd_lib_error</a>(__FILE__, __LINE__, __FUNCTION__, errno, ##args)</td> </tr> </table> </div><div class="memdoc"> <p>Shows a system error message (related to <code>errno</code>). </p> </div> </div> <h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="gac24b8de276929202a3e3d0b45c20b6c1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef void(* snd_lib_error_handler_t)(const char *file, int line, const char *function, int err, const char *fmt,...)</td> </tr> </table> </div><div class="memdoc"> <p>Error handler callback. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">file</td><td>Source file name. </td></tr> <tr><td class="paramname">line</td><td>Line number. </td></tr> <tr><td class="paramname">function</td><td>Function name. </td></tr> <tr><td class="paramname">err</td><td>Value of <code>errno</code>, or 0 if not relevant. </td></tr> <tr><td class="paramname">fmt</td><td><code>printf(3)</code> format. </td></tr> <tr><td class="paramname">...</td><td><code>printf(3)</code> arguments.</td></tr> </table> </dd> </dl> <p>A function of this type is called by the ALSA library when an error occurs. This function usually shows the message on the screen, and/or logs it. </p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga6ba1f0aa6c6bc5d335ab297d6019cb03"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_lib_error_set_handler </td> <td>(</td> <td class="paramtype"><a class="el" href="group___error.html#gac24b8de276929202a3e3d0b45c20b6c1">snd_lib_error_handler_t</a> </td> <td class="paramname"><em>handler</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Sets the error handler. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">handler</td><td>The pointer to the new error handler function.</td></tr> </table> </dd> </dl> <p>This function sets a new error handler, or (if <code>handler</code> is <code>NULL</code>) the default one which prints the error messages to <code>stderr</code>. </p> </div> </div> <a class="anchor" id="ga182bbadf2349e11602bc531e8cf22f7e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* snd_strerror </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>errnum</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Returns the message for an error code. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">errnum</td><td>The error code number, which must be a system error code or an ALSA error code. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The ASCII description of the given numeric error code. </dd></dl> <dl><dt><b>Examples: </b></dt><dd><a class="el" href="_2test_2latency_8c-example.html#a2">/test/latency.c</a>, <a class="el" href="_2test_2pcm_8c-example.html#a11">/test/pcm.c</a>, <a class="el" href="_2test_2pcm_min_8c-example.html#a2">/test/pcm_min.c</a>, and <a class="el" href="_2test_2timer_8c-example.html#a2">/test/timer.c</a>.</dd> </dl> </div> </div> <h2 class="groupheader">Variable Documentation</h2> <a class="anchor" id="gad6a605072dcc056de5f86d67687d90a6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group___error.html#gac24b8de276929202a3e3d0b45c20b6c1">snd_lib_error_handler_t</a> snd_lib_error</td> </tr> </table> </div><div class="memdoc"> <p>Pointer to the error handler function. For internal use only. </p> </div> </div> <a class="anchor" id="gad6a605072dcc056de5f86d67687d90a6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group___error.html#gac24b8de276929202a3e3d0b45c20b6c1">snd_lib_error_handler_t</a> snd_lib_error = snd_lib_error_default</td> </tr> </table> </div><div class="memdoc"> <p>Pointer to the error handler function. For internal use only. </p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>