| Current File : //proc/self/root/kunden/usr/share/doc/alsa-lib-devel/doxygen/html/group___error.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<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/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">ALSA project - the C library reference
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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="#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__, __func__, 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__, __func__, 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:gae71d39953bf482ba487d811a69a9175c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error.html#gae71d39953bf482ba487d811a69a9175c">snd_lib_error_handler_t</a>) (const char *file, int line, const char *function, int err, const char *fmt,...)</td></tr>
<tr class="memdesc:gae71d39953bf482ba487d811a69a9175c"><td class="mdescLeft"> </td><td class="mdescRight">Error handler callback. <a href="group___error.html#gae71d39953bf482ba487d811a69a9175c">More...</a><br /></td></tr>
<tr class="separator:gae71d39953bf482ba487d811a69a9175c"><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="group___error.html#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#gae71d39953bf482ba487d811a69a9175c">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="group___error.html#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#gae71d39953bf482ba487d811a69a9175c">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#gae71d39953bf482ba487d811a69a9175c">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 id="ga07b06f3c54db1c1d382e02b59b4fb652"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga07b06f3c54db1c1d382e02b59b4fb652">◆ </a></span>SND_ERROR_ALISP_NIL</h2>
<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 id="ga4e74ed65daac8e1737b7ec7b38d11ab4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4e74ed65daac8e1737b7ec7b38d11ab4">◆ </a></span>SND_ERROR_BEGIN</h2>
<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 id="gae24d4fe06c0a7478ebdaeeeca55d34c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae24d4fe06c0a7478ebdaeeeca55d34c5">◆ </a></span>SND_ERROR_INCOMPATIBLE_VERSION</h2>
<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 id="ga281420eb1344fe9f01d67d20c92457f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga281420eb1344fe9f01d67d20c92457f0">◆ </a></span>SNDERR</h2>
<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__, __func__, 0, ##args)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows a sound error message. </p>
</div>
</div>
<a id="ga6a6d50d5d5c51d971732e9925a226435"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6a6d50d5d5c51d971732e9925a226435">◆ </a></span>SYSERR</h2>
<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__, __func__, 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 id="gae71d39953bf482ba487d811a69a9175c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae71d39953bf482ba487d811a69a9175c">◆ </a></span>snd_lib_error_handler_t</h2>
<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 id="ga6ba1f0aa6c6bc5d335ab297d6019cb03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6ba1f0aa6c6bc5d335ab297d6019cb03">◆ </a></span>snd_lib_error_set_handler()</h2>
<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#gae71d39953bf482ba487d811a69a9175c">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 id="ga182bbadf2349e11602bc531e8cf22f7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga182bbadf2349e11602bc531e8cf22f7e">◆ </a></span>snd_strerror()</h2>
<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 class="section examples"><dt>Examples</dt><dd><a class="el" href="_2test_2latency_8c-example.html#a3">/test/latency.c</a>, <a class="el" href="_2test_2pcm_8c-example.html#a12">/test/pcm.c</a>, <a class="el" href="_2test_2pcm_min_8c-example.html#a2">/test/pcm_min.c</a>, <a class="el" href="_2test_2rawmidi_8c-example.html#a8">/test/rawmidi.c</a>, and <a class="el" href="_2test_2timer_8c-example.html#a3">/test/timer.c</a>.</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="gad6a605072dcc056de5f86d67687d90a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad6a605072dcc056de5f86d67687d90a6">◆ </a></span>snd_lib_error <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___error.html#gae71d39953bf482ba487d811a69a9175c">snd_lib_error_handler_t</a> snd_lib_error</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the error handler function. For internal use only. </p>
</div>
</div>
<a id="gad6a605072dcc056de5f86d67687d90a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad6a605072dcc056de5f86d67687d90a6">◆ </a></span>snd_lib_error <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___error.html#gae71d39953bf482ba487d811a69a9175c">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="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>