libogg-1.0/doc/ogg/ogg_stream_clear.html

   1 <html>
   2
   3 <head>
   4 <title>libogg - function - ogg_stream_clear</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>libogg documentation</p></td>
  12 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ogg_stream_clear</h1>
  17
  18 <p><i>declared in "ogg/ogg.h";</i></p>
  19
  20 <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.
  21 <br><br>
  22 <table border=0 color=black cellspacing=0 cellpadding=7>
  23 <tr bgcolor=#cccccc>
  24         <td>
  25 <pre><b>
  26 int ogg_stream_clear(ogg_stream_state *os);
  27 </b></pre>
  28         </td>
  29 </tr>
  30 </table>
  31
  32 <h3>Parameters</h3>
  33 <dl>
  34 <dt><i>os</i></dt>
  35 <dd>Pointer to the ogg_stream_state struct to be cleared.</dd>
  36 </dl>
  37
  38
  39 <h3>Return Values</h3>
  40 <blockquote>
  41 <li>
  42 0 is always returned.</li>
  43 </blockquote>
  44 <p>
  45
  46 <br><br>
  47 <hr noshade>
  48 <table border=0 width=100%>
  49 <tr valign=top>
  50 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
  51 <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>
  52 </tr><tr>
  53 <td><p class=tiny>libogg documentation</p></td>
  54 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
  55 </tr>
  56 </table>
  57
  58
  59 </body>
  60
  61 </html>