File: //usr/share/doc/alsa-lib-devel-1.0.17/lib64/html/group___input.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ALSA project - the C library reference: Input Interface</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<h1>Input Interface</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef _snd_input </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal structure for an input object. <a href="#g942229a624fb1eaccc9d61d537b9d94d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef enum <a class="el" href="group___input.html#gbfd658f37e834dcd84124d039ffec41a">_snd_input_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#g4b6fab04c59642e7f5d87058977811a9">snd_input_type_t</a></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#gbfd658f37e834dcd84124d039ffec41a">_snd_input_type</a> { <a class="el" href="group___input.html#ggbfd658f37e834dcd84124d039ffec41a5a433f859232c686072794b252e4412c">SND_INPUT_STDIO</a>,
<a class="el" href="group___input.html#ggbfd658f37e834dcd84124d039ffec41acf40786386583262727a69143a0c610c">SND_INPUT_BUFFER</a>
}</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#g8caeaecd3c9d9a3d85d1203eb64b3351">snd_input_stdio_open</a> (<a class="el" href="group___input.html#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> **inputp, const char *file, const char *mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new input object reading from a file. <a href="#g8caeaecd3c9d9a3d85d1203eb64b3351"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#g31f474dbd036c36d459df9d12dbd83fc">snd_input_stdio_attach</a> (<a class="el" href="group___input.html#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> **inputp, FILE *fp, int _close)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new input object using an existing stdio <code>FILE</code> pointer. <a href="#g31f474dbd036c36d459df9d12dbd83fc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#g83f271c6a717393c7a634bd690082474">snd_input_buffer_open</a> (<a class="el" href="group___input.html#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> **inputp, const char *buffer, ssize_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new input object from a memory buffer. <a href="#g83f271c6a717393c7a634bd690082474"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#gea9461452d068426713206728ec481e9">snd_input_close</a> (<a class="el" href="group___input.html#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> *input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes an input handle. <a href="#gea9461452d068426713206728ec481e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#g97439af0c5ad83c48d88e27d7a96bf04">snd_input_scanf</a> (<a class="el" href="group___input.html#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> *input, const char *format,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads formatted input (like <code>fscanf(3)</code>) from an input handle. <a href="#g97439af0c5ad83c48d88e27d7a96bf04"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#gc86cccfc94b57fe2909fcba723d1a883">snd_input_gets</a> (<a class="el" href="group___input.html#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> *input, char *str, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a line from an input handle (like <code>fgets(3)</code>). <a href="#gc86cccfc94b57fe2909fcba723d1a883"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#ge5199126e5767c3826e5ed041b2a7ebd">snd_input_getc</a> (<a class="el" href="group___input.html#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> *input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a character from an input handle (like <code>fgetc(3)</code>). <a href="#ge5199126e5767c3826e5ed041b2a7ebd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___input.html#gba2d3e5ec04262c82d3b0c98c1992991">snd_input_ungetc</a> (<a class="el" href="group___input.html#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> *input, int c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Puts the last character read back to an input handle (like <code>ungetc(3)</code>). <a href="#gba2d3e5ec04262c82d3b0c98c1992991"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The input functions present an interface similar to the stdio functions on top of different underlying input sources.<p>
The <a class="el" href="group___config.html#g0743418194fd9570fe9ff4bdee687349">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. <hr><h2>Typedef Documentation</h2>
<a class="anchor" name="g942229a624fb1eaccc9d61d537b9d94d"></a><!-- doxytag: member="input.h::snd_input_t" ref="g942229a624fb1eaccc9d61d537b9d94d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _snd_input <a class="el" href="group___input.html#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Internal structure for an input object.
<p>
The ALSA library uses a pointer to this structure as a handle to an input object. Applications don't access its contents directly.
</div>
</div><p>
<a class="anchor" name="g4b6fab04c59642e7f5d87058977811a9"></a><!-- doxytag: member="input.h::snd_input_type_t" ref="g4b6fab04c59642e7f5d87058977811a9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group___input.html#gbfd658f37e834dcd84124d039ffec41a">_snd_input_type</a> <a class="el" href="group___input.html#g4b6fab04c59642e7f5d87058977811a9">snd_input_type_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Input type.
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="gbfd658f37e834dcd84124d039ffec41a"></a><!-- doxytag: member="input.h::_snd_input_type" ref="gbfd658f37e834dcd84124d039ffec41a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group___input.html#gbfd658f37e834dcd84124d039ffec41a">_snd_input_type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Input type. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="ggbfd658f37e834dcd84124d039ffec41a5a433f859232c686072794b252e4412c"></a><!-- doxytag: member="SND_INPUT_STDIO" ref="ggbfd658f37e834dcd84124d039ffec41a5a433f859232c686072794b252e4412c" args="" -->SND_INPUT_STDIO</em> </td><td>
Input from a stdio stream. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="ggbfd658f37e834dcd84124d039ffec41acf40786386583262727a69143a0c610c"></a><!-- doxytag: member="SND_INPUT_BUFFER" ref="ggbfd658f37e834dcd84124d039ffec41acf40786386583262727a69143a0c610c" args="" -->SND_INPUT_BUFFER</em> </td><td>
Input from a memory buffer. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g83f271c6a717393c7a634bd690082474"></a><!-- doxytag: member="input.h::snd_input_buffer_open" ref="g83f271c6a717393c7a634bd690082474" args="(snd_input_t **inputp, const char *buffer, ssize_t size)" -->
<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#g942229a624fb1eaccc9d61d537b9d94d">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a new input object from a memory buffer.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>inputp</em> </td><td>The function puts the pointer to the new input object at the address specified by <code>inputp</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>Address of the input buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Size of the input buffer. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise a negative error code.</dd></dl>
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.
</div>
</div><p>
<a class="anchor" name="gea9461452d068426713206728ec481e9"></a><!-- doxytag: member="input.h::snd_input_close" ref="gea9461452d068426713206728ec481e9" args="(snd_input_t *input)" -->
<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#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> * </td>
<td class="paramname"> <em>input</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Closes an input handle.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>The input handle to be closed. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise a negative error code. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge5199126e5767c3826e5ed041b2a7ebd"></a><!-- doxytag: member="input.h::snd_input_getc" ref="ge5199126e5767c3826e5ed041b2a7ebd" args="(snd_input_t *input)" -->
<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#g942229a624fb1eaccc9d61d537b9d94d">snd_input_t</a> * </td>
<td class="paramname"> <em>input</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads a character from an input handle (like <code>fgetc(3)</code>).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>The input handle. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The character read, or <code>EOF</code> on end of file or error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc86cccfc94b57fe2909fcba723d1a883"></a><!-- doxytag: member="input.h::snd_input_gets" ref="gc86cccfc94b57fe2909fcba723d1a883" args="(snd_input_t *input, char *str, size_t size)" -->
<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#g942229a624fb1eaccc9d61d537b9d94d">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads a line from an input handle (like <code>fgets(3)</code>).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>The input handle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>Address of the destination buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>The size of the destination buffer. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Pointer to the buffer if successful, otherwise <code>NULL</code>.</dd></dl>
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.
</div>
</div><p>
<a class="anchor" name="g97439af0c5ad83c48d88e27d7a96bf04"></a><!-- doxytag: member="input.h::snd_input_scanf" ref="g97439af0c5ad83c48d88e27d7a96bf04" args="(snd_input_t *input, const char *format,...)" -->
<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#g942229a624fb1eaccc9d61d537b9d94d">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads formatted input (like <code>fscanf(3)</code>) from an input handle.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>The input handle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>Format string in <code>fscanf</code> format. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>Other <code>fscanf</code> arguments. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of input items assigned, or <code>EOF</code>.</dd></dl>
<dl compact><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><p>
<a class="anchor" name="g31f474dbd036c36d459df9d12dbd83fc"></a><!-- doxytag: member="input.h::snd_input_stdio_attach" ref="g31f474dbd036c36d459df9d12dbd83fc" args="(snd_input_t **inputp, FILE *fp, int _close)" -->
<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#g942229a624fb1eaccc9d61d537b9d94d">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a new input object using an existing stdio <code>FILE</code> pointer.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>inputp</em> </td><td>The function puts the pointer to the new input object at the address specified by <code>inputp</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fp</em> </td><td>The <code>FILE</code> pointer to read from. Reading begins at the current file position. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_close</em> </td><td>Close flag. Set this to 1 if <a class="el" href="group___input.html#gea9461452d068426713206728ec481e9">snd_input_close</a> should close <code>fp</code> by calling <code>fclose</code>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise a negative error code. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g8caeaecd3c9d9a3d85d1203eb64b3351"></a><!-- doxytag: member="input.h::snd_input_stdio_open" ref="g8caeaecd3c9d9a3d85d1203eb64b3351" args="(snd_input_t **inputp, const char *file, const char *mode)" -->
<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#g942229a624fb1eaccc9d61d537b9d94d">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a new input object reading from a file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>inputp</em> </td><td>The functions puts the pointer to the new input object at the address specified by <code>inputp</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>The name of the file to read from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>The open mode, like <code>fopen(3)</code>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise a negative error code. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gba2d3e5ec04262c82d3b0c98c1992991"></a><!-- doxytag: member="input.h::snd_input_ungetc" ref="gba2d3e5ec04262c82d3b0c98c1992991" args="(snd_input_t *input, int c)" -->
<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#g942229a624fb1eaccc9d61d537b9d94d">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>The input handle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>The character to push back. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The character pushed back, or <code>EOF</code> on error. </dd></dl>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jan 20 22:42:10 2009 for ALSA project - the C library reference by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>