doc/vorbisfile/ov_clear.html

   1 <html>
   2
   3 <head>
   4 <title>vorbisfile - function - ov_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>vorbisfile documentation</p></td>
  12 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ov_clear</h1>
  17
  18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  19
  20 <p> After a bitstream has been opened using <a href="ov_open.html">ov_open</a> and decoding is complete, you must call <tt>ov_clear()</tt> to clear
  21 the decoder's buffers and close the file for you.
  22 <br><br>
  23 <table border=0 color=black cellspacing=0 cellpadding=7>
  24 <tr bgcolor=#cccccc>
  25         <td>
  26 <pre><b>
  27 int ov_clear(OggVorbis_File *vf);
  28 </b></pre>
  29         </td>
  30 </tr>
  31 </table>
  32
  33 <h3>Parameters</h3>
  34 <dl>
  35 <dt><i>vf</i></dt>
  36 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile
  37 functions.  After <tt>ov_clear</tt> has been called, the structure is deallocated and can no longer be used.</dd>
  38 </dl>
  39
  40
  41 <h3>Return Values</h3>
  42 <blockquote>
  43 <li>
  44 0 for success</li>
  45 </blockquote>
  46
  47
  48 <br><br>
  49 <hr noshade>
  50 <table border=0 width=100%>
  51 <tr valign=top>
  52 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  53 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
  54 </tr><tr>
  55 <td><p class=tiny>vorbisfile documentation</p></td>
  56 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  57 </tr>
  58 </table>
  59
  60
  61 </body>
  62
  63 </html>