<!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.7"/> <title>ALSA project - the C library reference: /home/iurt/rpmbuild/BUILD/alsa-lib-1.0.28/include/input.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="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.7 --> <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 class="current"><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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <!-- 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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">input.h</div> </div> </div><!--header--> <div class="contents"> <a href="input_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> </div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/*</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * This library is free software; you can redistribute it and/or modify</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * it under the terms of the GNU Lesser General Public License as</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * published by the Free Software Foundation; either version 2.1 of</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * the License, or (at your option) any later version.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * This program is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * GNU Lesser General Public License for more details.</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> *</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef __ALSA_INPUT_H</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define __ALSA_INPUT_H</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301"> 54</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>_snd_input <a class="code" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a>;</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group___input.html#ga95856616f8604ef37e7f5e6738ffad8a"> 57</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> _snd_input_type {</div> <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group___input.html#gga95856616f8604ef37e7f5e6738ffad8aa2d48649c7cb19e419a82b2c4bab68515"> 59</a></span>  <a class="code" href="group___input.html#gga95856616f8604ef37e7f5e6738ffad8aa2d48649c7cb19e419a82b2c4bab68515">SND_INPUT_STDIO</a>,</div> <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="group___input.html#gga95856616f8604ef37e7f5e6738ffad8aa0d269e19ac019b61ec5e3afa4a1d9b67"> 61</a></span>  <a class="code" href="group___input.html#gga95856616f8604ef37e7f5e6738ffad8aa0d269e19ac019b61ec5e3afa4a1d9b67">SND_INPUT_BUFFER</a></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> } <a class="code" href="group___input.html#ga95856616f8604ef37e7f5e6738ffad8a">snd_input_type_t</a>;</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">int</span> <a class="code" href="group___input.html#ga68ff91aaa391b39f5a3082e202fdd2ff">snd_input_stdio_open</a>(<a class="code" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> **inputp, <span class="keyword">const</span> <span class="keywordtype">char</span> *file, <span class="keyword">const</span> <span class="keywordtype">char</span> *mode);</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">int</span> <a class="code" href="group___input.html#ga70e6704164f80072bfa118160ff81d54">snd_input_stdio_attach</a>(<a class="code" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> **inputp, FILE *fp, <span class="keywordtype">int</span> _close);</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keywordtype">int</span> <a class="code" href="group___input.html#ga3c7947884b1caf50117bcecd23a3cc22">snd_input_buffer_open</a>(<a class="code" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> **inputp, <span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, ssize_t size);</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">int</span> <a class="code" href="group___input.html#ga4c86d6c288e2b1be3fe2efca6859cdd6">snd_input_close</a>(<a class="code" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> *input);</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">int</span> <a class="code" href="group___input.html#ga079ba3d8ad9cfba4003c28520c2f8121">snd_input_scanf</a>(<a class="code" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> *input, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...)</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#ifndef DOC_HIDDEN</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  __attribute__ ((format (scanf, 2, 3)))</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  ;</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">char</span> *<a class="code" href="group___input.html#gabc17742247f4733f1891c2caec453988">snd_input_gets</a>(<a class="code" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> *input, <span class="keywordtype">char</span> *str, <span class="keywordtype">size_t</span> size);</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">int</span> <a class="code" href="group___input.html#gafb9476884661a2d685e59e58740cc9e6">snd_input_getc</a>(<a class="code" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> *input);</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">int</span> <a class="code" href="group___input.html#gad665d319d2d0a4127110c141ef99a02b">snd_input_ungetc</a>(<a class="code" href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a> *input, <span class="keywordtype">int</span> c);</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif </span><span class="comment">/* __ALSA_INPUT_H */</span><span class="preprocessor"></span></div> <div class="ttc" id="group___input_html_ga079ba3d8ad9cfba4003c28520c2f8121"><div class="ttname"><a href="group___input.html#ga079ba3d8ad9cfba4003c28520c2f8121">snd_input_scanf</a></div><div class="ttdeci">int snd_input_scanf(snd_input_t *input, const char *format,...)</div><div class="ttdoc">Reads formatted input (like fscanf(3)) from an input handle. </div><div class="ttdef"><b>Definition:</b> input.c:74</div></div> <div class="ttc" id="group___input_html_ga3c7947884b1caf50117bcecd23a3cc22"><div class="ttname"><a href="group___input.html#ga3c7947884b1caf50117bcecd23a3cc22">snd_input_buffer_open</a></div><div class="ttdeci">int snd_input_buffer_open(snd_input_t **inputp, const char *buffer, ssize_t size)</div><div class="ttdoc">Creates a new input object from a memory buffer. </div><div class="ttdef"><b>Definition:</b> input.c:306</div></div> <div class="ttc" id="group___input_html_ga39165553a2907c5a27f325e3ce4e8301"><div class="ttname"><a href="group___input.html#ga39165553a2907c5a27f325e3ce4e8301">snd_input_t</a></div><div class="ttdeci">struct _snd_input snd_input_t</div><div class="ttdoc">Internal structure for an input object. </div><div class="ttdef"><b>Definition:</b> input.h:54</div></div> <div class="ttc" id="group___input_html_gafb9476884661a2d685e59e58740cc9e6"><div class="ttname"><a href="group___input.html#gafb9476884661a2d685e59e58740cc9e6">snd_input_getc</a></div><div class="ttdeci">int snd_input_getc(snd_input_t *input)</div><div class="ttdoc">Reads a character from an input handle (like fgetc(3)). </div><div class="ttdef"><b>Definition:</b> input.c:104</div></div> <div class="ttc" id="group___input_html_gad665d319d2d0a4127110c141ef99a02b"><div class="ttname"><a href="group___input.html#gad665d319d2d0a4127110c141ef99a02b">snd_input_ungetc</a></div><div class="ttdeci">int snd_input_ungetc(snd_input_t *input, int c)</div><div class="ttdoc">Puts the last character read back to an input handle (like ungetc(3)). </div><div class="ttdef"><b>Definition:</b> input.c:115</div></div> <div class="ttc" id="group___input_html_gabc17742247f4733f1891c2caec453988"><div class="ttname"><a href="group___input.html#gabc17742247f4733f1891c2caec453988">snd_input_gets</a></div><div class="ttdeci">char * snd_input_gets(snd_input_t *input, char *str, size_t size)</div><div class="ttdoc">Reads a line from an input handle (like fgets(3)). </div><div class="ttdef"><b>Definition:</b> input.c:94</div></div> <div class="ttc" id="group___input_html_gga95856616f8604ef37e7f5e6738ffad8aa2d48649c7cb19e419a82b2c4bab68515"><div class="ttname"><a href="group___input.html#gga95856616f8604ef37e7f5e6738ffad8aa2d48649c7cb19e419a82b2c4bab68515">SND_INPUT_STDIO</a></div><div class="ttdef"><b>Definition:</b> input.h:59</div></div> <div class="ttc" id="group___input_html_ga95856616f8604ef37e7f5e6738ffad8a"><div class="ttname"><a href="group___input.html#ga95856616f8604ef37e7f5e6738ffad8a">snd_input_type_t</a></div><div class="ttdeci">snd_input_type_t</div><div class="ttdef"><b>Definition:</b> input.h:57</div></div> <div class="ttc" id="group___input_html_ga4c86d6c288e2b1be3fe2efca6859cdd6"><div class="ttname"><a href="group___input.html#ga4c86d6c288e2b1be3fe2efca6859cdd6">snd_input_close</a></div><div class="ttdeci">int snd_input_close(snd_input_t *input)</div><div class="ttdoc">Closes an input handle. </div><div class="ttdef"><b>Definition:</b> input.c:58</div></div> <div class="ttc" id="group___input_html_gga95856616f8604ef37e7f5e6738ffad8aa0d269e19ac019b61ec5e3afa4a1d9b67"><div class="ttname"><a href="group___input.html#gga95856616f8604ef37e7f5e6738ffad8aa0d269e19ac019b61ec5e3afa4a1d9b67">SND_INPUT_BUFFER</a></div><div class="ttdef"><b>Definition:</b> input.h:61</div></div> <div class="ttc" id="group___input_html_ga70e6704164f80072bfa118160ff81d54"><div class="ttname"><a href="group___input.html#ga70e6704164f80072bfa118160ff81d54">snd_input_stdio_attach</a></div><div class="ttdeci">int snd_input_stdio_attach(snd_input_t **inputp, FILE *fp, int _close)</div><div class="ttdoc">Creates a new input object using an existing stdio FILE pointer. </div><div class="ttdef"><b>Definition:</b> input.c:179</div></div> <div class="ttc" id="group___input_html_ga68ff91aaa391b39f5a3082e202fdd2ff"><div class="ttname"><a href="group___input.html#ga68ff91aaa391b39f5a3082e202fdd2ff">snd_input_stdio_open</a></div><div class="ttdeci">int snd_input_stdio_open(snd_input_t **inputp, const char *file, const char *mode)</div><div class="ttdoc">Creates a new input object reading from a file. </div><div class="ttdef"><b>Definition:</b> input.c:209</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Wed Jun 18 2014 05:47:49 for ALSA project - the C library reference by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.7 </small></address> </body> </html>