<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>ALSA project - the C library reference: Output Interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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">
<img id="MSearchSelect" src="search/search.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)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>Output Interface</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct _snd_output </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal structure for an output object. <a href="#ga49729cc6454539495c1f5b6e95cd474a"></a><br/></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#ga7217dd8d10e2491388e866d3354a4b29">snd_output_type_t</a> { <a class="el" href="group___output.html#gga7217dd8d10e2491388e866d3354a4b29ad8291a0da96f6bf0cc0352e256fe8c50">SND_OUTPUT_STDIO</a>,
<a class="el" href="group___output.html#gga7217dd8d10e2491388e866d3354a4b29a5630f21823bbe05e6547b8cc27af4e37">SND_OUTPUT_BUFFER</a>
}</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#gae7b87e8cfcc2d46b124b2ad221ed6435">snd_output_stdio_open</a> (<a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> **outputp, const char *file, const char *mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new output object writing to a file. <a href="#gae7b87e8cfcc2d46b124b2ad221ed6435"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#gaca78d01bf6d081274650794861373c7d">snd_output_stdio_attach</a> (<a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> **outputp, FILE *fp, int _close)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new output object using an existing stdio <code>FILE</code> pointer. <a href="#gaca78d01bf6d081274650794861373c7d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#gafb4d1ae52ed7148b0abab0de3257fae1">snd_output_buffer_open</a> (<a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> **outputp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new output object with an auto-extending memory buffer. <a href="#gafb4d1ae52ed7148b0abab0de3257fae1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#gaae66e163bd719593b6787d922546a055">snd_output_buffer_string</a> (<a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> *output, char **buf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the address of the buffer of a <a class="el" href="group___output.html#gga7217dd8d10e2491388e866d3354a4b29a5630f21823bbe05e6547b8cc27af4e37">SND_OUTPUT_BUFFER</a> output handle. <a href="#gaae66e163bd719593b6787d922546a055"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#gab4be4e572d2a0d0f2f46faf8d45aa35d">snd_output_close</a> (<a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> *output)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes an output handle. <a href="#gab4be4e572d2a0d0f2f46faf8d45aa35d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#ga5dd8e7d3089a82d8449a9dff221caf1c">snd_output_printf</a> (<a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> *output, const char *format,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes formatted output (like <code>fprintf(3)</code>) to an output handle. <a href="#ga5dd8e7d3089a82d8449a9dff221caf1c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#gae01572ae47fd3ead25ffd6856118780f">snd_output_vprintf</a> (<a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> *output, const char *format, va_list args)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes formatted output (like <code>fprintf(3)</code>) to an output handle. <a href="#gae01572ae47fd3ead25ffd6856118780f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#gaa370cff392c8fdaf03e08c667561d4ec">snd_output_puts</a> (<a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> *output, const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a string to an output handle (like <code>fputs(3)</code>). <a href="#gaa370cff392c8fdaf03e08c667561d4ec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#ga7b2b8c27042964a5b57acabe0af6e30b">snd_output_putc</a> (<a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> *output, int c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a character to an output handle (like <code>putc(3)</code>). <a href="#ga7b2b8c27042964a5b57acabe0af6e30b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___output.html#ga9d188a05400c944bc1f70d757c179226">snd_output_flush</a> (<a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> *output)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes an output handle (like fflush(3)). <a href="#ga9d188a05400c944bc1f70d757c179226"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The output functions present an interface similar to the stdio functions on top of different underlying output destinations.</p>
<p>Many PCM debugging functions (<code>snd_pcm_xxx_dump_xxx</code>) use such an output handle to be able to write not only to the screen but also to other destinations, e.g. to files or to memory buffers. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga49729cc6454539495c1f5b6e95cd474a"></a><!-- doxytag: member="output.h::snd_output_t" ref="ga49729cc6454539495c1f5b6e95cd474a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _snd_output <a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Internal structure for an output object. </p>
<p>The ALSA library uses a pointer to this structure as a handle to an output object. Applications don't access its contents directly. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_2test_2latency_8c-example.html#a1">/test/latency.c</a>, <a class="el" href="_2test_2pcm_8c-example.html#a2">/test/pcm.c</a>, and <a class="el" href="_2test_2pcm__min_8c-example.html#a0">/test/pcm_min.c</a>.</dd>
</dl>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga7217dd8d10e2491388e866d3354a4b29"></a><!-- doxytag: member="output.h::snd_output_type_t" ref="ga7217dd8d10e2491388e866d3354a4b29" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group___output.html#ga7217dd8d10e2491388e866d3354a4b29">snd_output_type_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Output type. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga7217dd8d10e2491388e866d3354a4b29ad8291a0da96f6bf0cc0352e256fe8c50"></a><!-- doxytag: member="SND_OUTPUT_STDIO" ref="gga7217dd8d10e2491388e866d3354a4b29ad8291a0da96f6bf0cc0352e256fe8c50" args="" -->SND_OUTPUT_STDIO</em> </td><td>
<p>Output to a stdio stream. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga7217dd8d10e2491388e866d3354a4b29a5630f21823bbe05e6547b8cc27af4e37"></a><!-- doxytag: member="SND_OUTPUT_BUFFER" ref="gga7217dd8d10e2491388e866d3354a4b29a5630f21823bbe05e6547b8cc27af4e37" args="" -->SND_OUTPUT_BUFFER</em> </td><td>
<p>Output to a memory buffer. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gafb4d1ae52ed7148b0abab0de3257fae1"></a><!-- doxytag: member="output.h::snd_output_buffer_open" ref="gafb4d1ae52ed7148b0abab0de3257fae1" args="(snd_output_t **outputp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_output_buffer_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> ** </td>
<td class="paramname"> <em>outputp</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new output object with an auto-extending memory buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>outputp</em> </td><td>The function puts the pointer to the new output object at the address specified by <code>outputp</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise a negative error code. </dd></dl>
</div>
</div>
<a class="anchor" id="gaae66e163bd719593b6787d922546a055"></a><!-- doxytag: member="output.h::snd_output_buffer_string" ref="gaae66e163bd719593b6787d922546a055" args="(snd_output_t *output, char **buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t snd_output_buffer_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> * </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>buf</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the address of the buffer of a <a class="el" href="group___output.html#gga7217dd8d10e2491388e866d3354a4b29a5630f21823bbe05e6547b8cc27af4e37">SND_OUTPUT_BUFFER</a> output handle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>The output handle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>The functions puts the current address of the buffer at the address specified by <code>buf</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The current size of valid data in the buffer.</dd></dl>
<p>The address of the buffer may become invalid when output functions or <a class="el" href="group___output.html#gab4be4e572d2a0d0f2f46faf8d45aa35d" title="Closes an output handle.">snd_output_close</a> are called. </p>
</div>
</div>
<a class="anchor" id="gab4be4e572d2a0d0f2f46faf8d45aa35d"></a><!-- doxytag: member="output.h::snd_output_close" ref="gab4be4e572d2a0d0f2f46faf8d45aa35d" args="(snd_output_t *output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_output_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> * </td>
<td class="paramname"> <em>output</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes an output handle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>The output handle to be closed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise a negative error code. </dd></dl>
</div>
</div>
<a class="anchor" id="ga9d188a05400c944bc1f70d757c179226"></a><!-- doxytag: member="output.h::snd_output_flush" ref="ga9d188a05400c944bc1f70d757c179226" args="(snd_output_t *output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_output_flush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> * </td>
<td class="paramname"> <em>output</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flushes an output handle (like fflush(3)). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>The output handle. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise <code>EOF</code>.</dd></dl>
<p>If the underlying destination is a stdio stream, this function calls <code>fflush</code>. If the underlying destination is a memory buffer, the write position is reset to the beginning of the buffer. <code>=</code>:-o </p>
</div>
</div>
<a class="anchor" id="ga5dd8e7d3089a82d8449a9dff221caf1c"></a><!-- doxytag: member="output.h::snd_output_printf" ref="ga5dd8e7d3089a82d8449a9dff221caf1c" args="(snd_output_t *output, const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_output_printf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> * </td>
<td class="paramname"> <em>output</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes formatted output (like <code>fprintf(3)</code>) to an output handle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>The output handle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>Format string in <code>fprintf</code> format. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>Other <code>fprintf</code> arguments. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of characters written, or a negative error code. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7b2b8c27042964a5b57acabe0af6e30b"></a><!-- doxytag: member="output.h::snd_output_putc" ref="ga7b2b8c27042964a5b57acabe0af6e30b" args="(snd_output_t *output, int c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_output_putc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> * </td>
<td class="paramname"> <em>output</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a character to an output handle (like <code>putc(3)</code>). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>The output handle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>The character. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise a negative error code or <code>EOF</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa370cff392c8fdaf03e08c667561d4ec"></a><!-- doxytag: member="output.h::snd_output_puts" ref="gaa370cff392c8fdaf03e08c667561d4ec" args="(snd_output_t *output, const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_output_puts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> * </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a string to an output handle (like <code>fputs(3)</code>). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>The output handle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>Pointer to the string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise a negative error code or <code>EOF</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="gaca78d01bf6d081274650794861373c7d"></a><!-- doxytag: member="output.h::snd_output_stdio_attach" ref="gaca78d01bf6d081274650794861373c7d" args="(snd_output_t **outputp, FILE *fp, int _close)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_output_stdio_attach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> ** </td>
<td class="paramname"> <em>outputp</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new output object using an existing stdio <code>FILE</code> pointer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>outputp</em> </td><td>The function puts the pointer to the new output object at the address specified by <code>outputp</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fp</em> </td><td>The <code>FILE</code> pointer to write to. Characters are written to the file starting 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___output.html#gab4be4e572d2a0d0f2f46faf8d45aa35d" title="Closes an output handle.">snd_output_close</a> should close <code>fp</code> by calling <code>fclose</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise a negative error code. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_2test_2latency_8c-example.html#a41">/test/latency.c</a>, and <a class="el" href="_2test_2pcm_8c-example.html#a61">/test/pcm.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae7b87e8cfcc2d46b124b2ad221ed6435"></a><!-- doxytag: member="output.h::snd_output_stdio_open" ref="gae7b87e8cfcc2d46b124b2ad221ed6435" args="(snd_output_t **outputp, const char *file, const char *mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_output_stdio_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> ** </td>
<td class="paramname"> <em>outputp</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new output object writing to a file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>outputp</em> </td><td>The function puts the pointer to the new output object at the address specified by <code>outputp</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>The name of the file to open. </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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Zero if successful, otherwise a negative error code. </dd></dl>
</div>
</div>
<a class="anchor" id="gae01572ae47fd3ead25ffd6856118780f"></a><!-- doxytag: member="output.h::snd_output_vprintf" ref="gae01572ae47fd3ead25ffd6856118780f" args="(snd_output_t *output, const char *format, va_list args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_output_vprintf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___output.html#ga49729cc6454539495c1f5b6e95cd474a">snd_output_t</a> * </td>
<td class="paramname"> <em>output</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">va_list </td>
<td class="paramname"> <em>args</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes formatted output (like <code>fprintf(3)</code>) to an output handle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>The output handle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>Format string in <code>fprintf</code> format. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>Other <code>fprintf</code> arguments. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of characters written, or a negative error code. </dd></dl>
</div>
</div>
</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>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Nov 20 07:42:24 2010 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.6.3 </small></address>
</body>
</html>
