EVOLUTION-MANAGER
Edit File: group___output.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: Output 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">Output 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:ga49729cc6454539495c1f5b6e95cd474a"><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 class="memdesc:ga49729cc6454539495c1f5b6e95cd474a"><td class="mdescLeft"> </td><td class="mdescRight">Internal structure for an output object. <a href="#ga49729cc6454539495c1f5b6e95cd474a">More...</a><br/></td></tr> <tr class="separator:ga49729cc6454539495c1f5b6e95cd474a"><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:ga7217dd8d10e2491388e866d3354a4b29"><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 class="separator:ga7217dd8d10e2491388e866d3354a4b29"><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:gae7b87e8cfcc2d46b124b2ad221ed6435"><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 class="memdesc:gae7b87e8cfcc2d46b124b2ad221ed6435"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new output object writing to a file. <a href="#gae7b87e8cfcc2d46b124b2ad221ed6435">More...</a><br/></td></tr> <tr class="separator:gae7b87e8cfcc2d46b124b2ad221ed6435"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaca78d01bf6d081274650794861373c7d"><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 class="memdesc:gaca78d01bf6d081274650794861373c7d"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new output object using an existing stdio <code>FILE</code> pointer. <a href="#gaca78d01bf6d081274650794861373c7d">More...</a><br/></td></tr> <tr class="separator:gaca78d01bf6d081274650794861373c7d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gafb4d1ae52ed7148b0abab0de3257fae1"><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 class="memdesc:gafb4d1ae52ed7148b0abab0de3257fae1"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new output object with an auto-extending memory buffer. <a href="#gafb4d1ae52ed7148b0abab0de3257fae1">More...</a><br/></td></tr> <tr class="separator:gafb4d1ae52ed7148b0abab0de3257fae1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaae66e163bd719593b6787d922546a055"><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 class="memdesc:gaae66e163bd719593b6787d922546a055"><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">More...</a><br/></td></tr> <tr class="separator:gaae66e163bd719593b6787d922546a055"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab4be4e572d2a0d0f2f46faf8d45aa35d"><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 class="memdesc:gab4be4e572d2a0d0f2f46faf8d45aa35d"><td class="mdescLeft"> </td><td class="mdescRight">Closes an output handle. <a href="#gab4be4e572d2a0d0f2f46faf8d45aa35d">More...</a><br/></td></tr> <tr class="separator:gab4be4e572d2a0d0f2f46faf8d45aa35d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5dd8e7d3089a82d8449a9dff221caf1c"><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 class="memdesc:ga5dd8e7d3089a82d8449a9dff221caf1c"><td class="mdescLeft"> </td><td class="mdescRight">Writes formatted output (like <code>fprintf(3)</code>) to an output handle. <a href="#ga5dd8e7d3089a82d8449a9dff221caf1c">More...</a><br/></td></tr> <tr class="separator:ga5dd8e7d3089a82d8449a9dff221caf1c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae01572ae47fd3ead25ffd6856118780f"><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 class="memdesc:gae01572ae47fd3ead25ffd6856118780f"><td class="mdescLeft"> </td><td class="mdescRight">Writes formatted output (like <code>fprintf(3)</code>) to an output handle. <a href="#gae01572ae47fd3ead25ffd6856118780f">More...</a><br/></td></tr> <tr class="separator:gae01572ae47fd3ead25ffd6856118780f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa370cff392c8fdaf03e08c667561d4ec"><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 class="memdesc:gaa370cff392c8fdaf03e08c667561d4ec"><td class="mdescLeft"> </td><td class="mdescRight">Writes a string to an output handle (like <code>fputs(3)</code>). <a href="#gaa370cff392c8fdaf03e08c667561d4ec">More...</a><br/></td></tr> <tr class="separator:gaa370cff392c8fdaf03e08c667561d4ec"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga7b2b8c27042964a5b57acabe0af6e30b"><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 class="memdesc:ga7b2b8c27042964a5b57acabe0af6e30b"><td class="mdescLeft"> </td><td class="mdescRight">Writes a character to an output handle (like <code>putc(3)</code>). <a href="#ga7b2b8c27042964a5b57acabe0af6e30b">More...</a><br/></td></tr> <tr class="separator:ga7b2b8c27042964a5b57acabe0af6e30b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9d188a05400c944bc1f70d757c179226"><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 class="memdesc:ga9d188a05400c944bc1f70d757c179226"><td class="mdescLeft"> </td><td class="mdescRight">Flushes an output handle (like fflush(3)). <a href="#ga9d188a05400c944bc1f70d757c179226">More...</a><br/></td></tr> <tr class="separator:ga9d188a05400c944bc1f70d757c179226"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">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> <h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="ga49729cc6454539495c1f5b6e95cd474a"></a> <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> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a class="anchor" id="ga7217dd8d10e2491388e866d3354a4b29"></a> <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> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga7217dd8d10e2491388e866d3354a4b29ad8291a0da96f6bf0cc0352e256fe8c50"></a>SND_OUTPUT_STDIO</em> </td><td class="fielddoc"> <p>Output to a stdio stream. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="gga7217dd8d10e2491388e866d3354a4b29a5630f21823bbe05e6547b8cc27af4e37"></a>SND_OUTPUT_BUFFER</em> </td><td class="fielddoc"> <p>Output to a memory buffer. </p> </td></tr> </table> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="gafb4d1ae52ed7148b0abab0de3257fae1"></a> <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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">outputp</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="section return"><dt>Returns</dt><dd>Zero if successful, otherwise a negative error code. </dd></dl> </div> </div> <a class="anchor" id="gaae66e163bd719593b6787d922546a055"></a> <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> </tr> <tr> <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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">output</td><td>The output handle. </td></tr> <tr><td class="paramname">buf</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="section return"><dt>Returns</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> <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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">output</td><td>The output 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="ga9d188a05400c944bc1f70d757c179226"></a> <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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">output</td><td>The output handle. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</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> <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> </tr> <tr> <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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">output</td><td>The output handle. </td></tr> <tr><td class="paramname">format</td><td>Format string in <code>fprintf</code> format. </td></tr> <tr><td class="paramname">...</td><td>Other <code>fprintf</code> arguments. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The number of characters written, or a negative error code. </dd></dl> </div> </div> <a class="anchor" id="ga7b2b8c27042964a5b57acabe0af6e30b"></a> <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> </tr> <tr> <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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">output</td><td>The output handle. </td></tr> <tr><td class="paramname">c</td><td>The character. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Zero if successful, otherwise a negative error code or <code>EOF</code>. </dd></dl> </div> </div> <a class="anchor" id="gaa370cff392c8fdaf03e08c667561d4ec"></a> <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> </tr> <tr> <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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">output</td><td>The output handle. </td></tr> <tr><td class="paramname">str</td><td>Pointer to the string. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Zero if successful, otherwise a negative error code or <code>EOF</code>. </dd></dl> </div> </div> <a class="anchor" id="gaca78d01bf6d081274650794861373c7d"></a> <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> </tr> <tr> <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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">outputp</td><td>The function puts the pointer to the new output object at the address specified by <code>outputp</code>. </td></tr> <tr><td class="paramname">fp</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 class="paramname">_close</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="section return"><dt>Returns</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#a36">/test/latency.c</a>, and <a class="el" href="_2test_2pcm_8c-example.html#a55">/test/pcm.c</a>.</dd> </dl> </div> </div> <a class="anchor" id="gae7b87e8cfcc2d46b124b2ad221ed6435"></a> <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> </tr> <tr> <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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">outputp</td><td>The function puts the pointer to the new output object at the address specified by <code>outputp</code>. </td></tr> <tr><td class="paramname">file</td><td>The name of the file to open. </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="gae01572ae47fd3ead25ffd6856118780f"></a> <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> </tr> <tr> <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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">output</td><td>The output handle. </td></tr> <tr><td class="paramname">format</td><td>Format string in <code>fprintf</code> format. </td></tr> <tr><td class="paramname">args</td><td>Other <code>fprintf</code> arguments. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The number of characters written, or a negative error code. </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>