examples/sfexamples/oggvorbiscodec/src/libogg/doc/ogg/ogg_stream_clear.html

00001 <html>
00002 
00003 <head>
00004 <title>libogg - function - ogg_stream_clear</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007 
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libogg documentation</p></td>
00012 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>ogg_stream_clear</h1>
00017 
00018 <p><i>declared in "ogg/ogg.h";</i></p>
00019 
00020 <p>This function clears the memory used by the <a href="ogg_sync_state.html">ogg_stream_state</a> struct, but does not free it.
00021 <br><br>
00022 <table border=0 color=black cellspacing=0 cellpadding=7>
00023 <tr bgcolor=#cccccc>
00024         <td>
00025 <pre><b>
00026 int ogg_stream_clear(ogg_stream_state *os);
00027 </b></pre>
00028         </td>
00029 </tr>
00030 </table>
00031 
00032 <h3>Parameters</h3>
00033 <dl>
00034 <dt><i>os</i></dt>
00035 <dd>Pointer to the ogg_stream_state struct to be cleared.</dd>
00036 </dl>
00037 
00038 
00039 <h3>Return Values</h3>
00040 <blockquote>
00041 <li>
00042 0 is always returned.</li>
00043 </blockquote>
00044 <p>
00045 
00046 <br><br>
00047 <hr noshade>
00048 <table border=0 width=100%>
00049 <tr valign=top>
00050 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
00051 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
00052 </tr><tr>
00053 <td><p class=tiny>libogg documentation</p></td>
00054 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00055 </tr>
00056 </table>
00057 
00058 
00059 </body>
00060 
00061 </html>

Generated by  doxygen 1.6.2