EVOLUTION-MANAGER
Edit File: group___input.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: Input Interface</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="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Input Interface</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:ga39165553a2907c5a27f325e3ce4e8301"><td class="memItemLeft" align="right" valign="top">typedef struct _snd_input </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a></td></tr> <tr class="memdesc:ga39165553a2907c5a27f325e3ce4e8301"><td class="mdescLeft"> </td><td class="mdescRight">Internal structure for an input object. <a href="#ga39165553a2907c5a27f325e3ce4e8301">More...</a><br/></td></tr> <tr class="separator:ga39165553a2907c5a27f325e3ce4e8301"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:ga95856616f8604ef37e7f5e6738ffad8a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#ga95856616f8604ef37e7f5e6738ffad8a">snd_input_type_t</a> { <a class="el" href="group___input.html#gga95856616f8604ef37e7f5e6738ffad8aa2d48649c7cb19e419a82b2c4bab68515">SND_INPUT_STDIO</a>, <a class="el" href="group___input.html#gga95856616f8604ef37e7f5e6738ffad8aa0d269e19ac019b61ec5e3afa4a1d9b67">SND_INPUT_BUFFER</a> }</td></tr> <tr class="separator:ga95856616f8604ef37e7f5e6738ffad8a"><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:ga68ff91aaa391b39f5a3082e202fdd2ff"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#ga68ff91aaa391b39f5a3082e202fdd2ff">snd_input_stdio_open</a> (<a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> **inputp, const char *file, const char *mode)</td></tr> <tr class="memdesc:ga68ff91aaa391b39f5a3082e202fdd2ff"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new input object reading from a file. <a href="#ga68ff91aaa391b39f5a3082e202fdd2ff">More...</a><br/></td></tr> <tr class="separator:ga68ff91aaa391b39f5a3082e202fdd2ff"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga70e6704164f80072bfa118160ff81d54"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#ga70e6704164f80072bfa118160ff81d54">snd_input_stdio_attach</a> (<a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> **inputp, FILE *fp, int _close)</td></tr> <tr class="memdesc:ga70e6704164f80072bfa118160ff81d54"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new input object using an existing stdio <code>FILE</code> pointer. <a href="#ga70e6704164f80072bfa118160ff81d54">More...</a><br/></td></tr> <tr class="separator:ga70e6704164f80072bfa118160ff81d54"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga3c7947884b1caf50117bcecd23a3cc22"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#ga3c7947884b1caf50117bcecd23a3cc22">snd_input_buffer_open</a> (<a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> **inputp, const char *buffer, ssize_t size)</td></tr> <tr class="memdesc:ga3c7947884b1caf50117bcecd23a3cc22"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new input object from a memory buffer. <a href="#ga3c7947884b1caf50117bcecd23a3cc22">More...</a><br/></td></tr> <tr class="separator:ga3c7947884b1caf50117bcecd23a3cc22"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4c86d6c288e2b1be3fe2efca6859cdd6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#ga4c86d6c288e2b1be3fe2efca6859cdd6">snd_input_close</a> (<a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> *input)</td></tr> <tr class="memdesc:ga4c86d6c288e2b1be3fe2efca6859cdd6"><td class="mdescLeft"> </td><td class="mdescRight">Closes an input handle. <a href="#ga4c86d6c288e2b1be3fe2efca6859cdd6">More...</a><br/></td></tr> <tr class="separator:ga4c86d6c288e2b1be3fe2efca6859cdd6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga079ba3d8ad9cfba4003c28520c2f8121"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#ga079ba3d8ad9cfba4003c28520c2f8121">snd_input_scanf</a> (<a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> *input, const char *format,...)</td></tr> <tr class="memdesc:ga079ba3d8ad9cfba4003c28520c2f8121"><td class="mdescLeft"> </td><td class="mdescRight">Reads formatted input (like <code>fscanf(3)</code>) from an input handle. <a href="#ga079ba3d8ad9cfba4003c28520c2f8121">More...</a><br/></td></tr> <tr class="separator:ga079ba3d8ad9cfba4003c28520c2f8121"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabc17742247f4733f1891c2caec453988"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#gabc17742247f4733f1891c2caec453988">snd_input_gets</a> (<a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> *input, char *str, size_t size)</td></tr> <tr class="memdesc:gabc17742247f4733f1891c2caec453988"><td class="mdescLeft"> </td><td class="mdescRight">Reads a line from an input handle (like <code>fgets(3)</code>). <a href="#gabc17742247f4733f1891c2caec453988">More...</a><br/></td></tr> <tr class="separator:gabc17742247f4733f1891c2caec453988"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gafb9476884661a2d685e59e58740cc9e6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#gafb9476884661a2d685e59e58740cc9e6">snd_input_getc</a> (<a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> *input)</td></tr> <tr class="memdesc:gafb9476884661a2d685e59e58740cc9e6"><td class="mdescLeft"> </td><td class="mdescRight">Reads a character from an input handle (like <code>fgetc(3)</code>). <a href="#gafb9476884661a2d685e59e58740cc9e6">More...</a><br/></td></tr> <tr class="separator:gafb9476884661a2d685e59e58740cc9e6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad665d319d2d0a4127110c141ef99a02b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#gad665d319d2d0a4127110c141ef99a02b">snd_input_ungetc</a> (<a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> *input, int c)</td></tr> <tr class="memdesc:gad665d319d2d0a4127110c141ef99a02b"><td class="mdescLeft"> </td><td class="mdescRight">Puts the last character read back to an input handle (like <code>ungetc(3)</code>). <a href="#gad665d319d2d0a4127110c141ef99a02b">More...</a><br/></td></tr> <tr class="separator:gad665d319d2d0a4127110c141ef99a02b"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>The input functions present an interface similar to the stdio functions on top of different underlying input sources.</p> <p>The <a class="el" href="group___config.html#ga51f79d1f24a519e126415c72210525b0" title="Loads a configuration tree. ">snd_config_load</a> function uses such an input handle to be able to load configurations not only from standard files but also from other sources, e.g. from memory buffers. </p> <h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="ga39165553a2907c5a27f325e3ce4e8301"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct _snd_input <a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a></td> </tr> </table> </div><div class="memdoc"> <p>Internal structure for an input object. </p> <p>The ALSA library uses a pointer to this structure as a handle to an input object. Applications don't access its contents directly. </p> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a class="anchor" id="ga95856616f8604ef37e7f5e6738ffad8a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="group___input.html#ga95856616f8604ef37e7f5e6738ffad8a">snd_input_type_t</a></td> </tr> </table> </div><div class="memdoc"> <p>Input type. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga95856616f8604ef37e7f5e6738ffad8aa2d48649c7cb19e419a82b2c4bab68515"></a>SND_INPUT_STDIO</em> </td><td class="fielddoc"> <p>Input from a stdio stream. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="gga95856616f8604ef37e7f5e6738ffad8aa0d269e19ac019b61ec5e3afa4a1d9b67"></a>SND_INPUT_BUFFER</em> </td><td class="fielddoc"> <p>Input from a memory buffer. </p> </td></tr> </table> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga3c7947884b1caf50117bcecd23a3cc22"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_input_buffer_open </td> <td>(</td> <td class="paramtype"><a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> ** </td> <td class="paramname"><em>inputp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>buf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">ssize_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Creates a new input object from a memory buffer. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">inputp</td><td>The function puts the pointer to the new input object at the address specified by <code>inputp</code>. </td></tr> <tr><td class="paramname">buf</td><td>Address of the input buffer. </td></tr> <tr><td class="paramname">size</td><td>Size of the input buffer. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Zero if successful, otherwise a negative error code.</dd></dl> <p>This functions creates a copy of the input buffer, so the application is not required to preserve the buffer after this function has been called. </p> </div> </div> <a class="anchor" id="ga4c86d6c288e2b1be3fe2efca6859cdd6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_input_close </td> <td>(</td> <td class="paramtype"><a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> * </td> <td class="paramname"><em>input</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Closes an input handle. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">input</td><td>The input handle to be closed. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Zero if successful, otherwise a negative error code. </dd></dl> </div> </div> <a class="anchor" id="gafb9476884661a2d685e59e58740cc9e6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_input_getc </td> <td>(</td> <td class="paramtype"><a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> * </td> <td class="paramname"><em>input</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Reads a character from an input handle (like <code>fgetc(3)</code>). </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">input</td><td>The input handle. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The character read, or <code>EOF</code> on end of file or error. </dd></dl> </div> </div> <a class="anchor" id="gabc17742247f4733f1891c2caec453988"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char* snd_input_gets </td> <td>(</td> <td class="paramtype"><a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> * </td> <td class="paramname"><em>input</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Reads a line from an input handle (like <code>fgets(3)</code>). </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">input</td><td>The input handle. </td></tr> <tr><td class="paramname">str</td><td>Address of the destination buffer. </td></tr> <tr><td class="paramname">size</td><td>The size of the destination buffer. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Pointer to the buffer if successful, otherwise <code>NULL</code>.</dd></dl> <p>Like <code>fgets</code>, the returned string is zero-terminated, and contains the new-line character <code>'\n'</code> if the line fits into the buffer. </p> </div> </div> <a class="anchor" id="ga079ba3d8ad9cfba4003c28520c2f8121"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_input_scanf </td> <td>(</td> <td class="paramtype"><a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> * </td> <td class="paramname"><em>input</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>format</em>, </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>Reads formatted input (like <code>fscanf(3)</code>) from an input handle. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">input</td><td>The input handle. </td></tr> <tr><td class="paramname">format</td><td>Format string in <code>fscanf</code> format. </td></tr> <tr><td class="paramname">...</td><td>Other <code>fscanf</code> arguments. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The number of input items assigned, or <code>EOF</code>.</dd></dl> <dl class="bug"><dt><b><a class="el" href="bug.html#_bug000001">Bug:</a></b></dt><dd>Reading from a memory buffer doesn't work. </dd></dl> </div> </div> <a class="anchor" id="ga70e6704164f80072bfa118160ff81d54"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_input_stdio_attach </td> <td>(</td> <td class="paramtype"><a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> ** </td> <td class="paramname"><em>inputp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">FILE * </td> <td class="paramname"><em>fp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>_close</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Creates a new input object using an existing stdio <code>FILE</code> pointer. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">inputp</td><td>The function puts the pointer to the new input object at the address specified by <code>inputp</code>. </td></tr> <tr><td class="paramname">fp</td><td>The <code>FILE</code> pointer to read from. Reading begins at the current file position. </td></tr> <tr><td class="paramname">_close</td><td>Close flag. Set this to 1 if <a class="el" href="group___input.html#ga4c86d6c288e2b1be3fe2efca6859cdd6" title="Closes an input handle. ">snd_input_close</a> should close <code>fp</code> by calling <code>fclose</code>. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Zero if successful, otherwise a negative error code. </dd></dl> </div> </div> <a class="anchor" id="ga68ff91aaa391b39f5a3082e202fdd2ff"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_input_stdio_open </td> <td>(</td> <td class="paramtype"><a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> ** </td> <td class="paramname"><em>inputp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>file</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>mode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Creates a new input object reading from a file. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">inputp</td><td>The functions puts the pointer to the new input object at the address specified by <code>inputp</code>. </td></tr> <tr><td class="paramname">file</td><td>The name of the file to read from. </td></tr> <tr><td class="paramname">mode</td><td>The open mode, like <code>fopen(3)</code>. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Zero if successful, otherwise a negative error code. </dd></dl> </div> </div> <a class="anchor" id="gad665d319d2d0a4127110c141ef99a02b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_input_ungetc </td> <td>(</td> <td class="paramtype"><a class="el" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> * </td> <td class="paramname"><em>input</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>c</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Puts the last character read back to an input handle (like <code>ungetc(3)</code>). </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">input</td><td>The input handle. </td></tr> <tr><td class="paramname">c</td><td>The character to push back. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The character pushed back, or <code>EOF</code> on error. </dd></dl> </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>