libogg-1.0/doc/ogg/ogg_sync_clear.html

   1 <html>
   2
   3 <head>
   4 <title>libogg - function - ogg_sync_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_sync_clear</h1>
  17
  18 <p><i>declared in "ogg/ogg.h";</i></p>
  19
  20 <p>This function is used to free the internal storage of an <a href="ogg_sync_state.html">ogg_sync_state</a> struct and resets the struct to the initial state.  To free the entire struct, <a href="ogg_sync_destroy.html">ogg_sync_destroy</a> should be used instead.  In situations where the struct needs to be reset but the internal storage does not need to be freed, <a href="ogg_sync_reset.html">ogg_sync_reset</a> should be used.
  21
  22 <br><br>
  23 <table border=0 color=black cellspacing=0 cellpadding=7>
  24 <tr bgcolor=#cccccc>
  25         <td>
  26 <pre><b>
  27 int ogg_sync_clear(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
  28 </b></pre>
  29         </td>
  30 </tr>
  31 </table>
  32
  33 <h3>Parameters</h3>
  34 <dl>
  35 <dt><i>oy</i></dt>
  36 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
  37 </dl>
  38
  39
  40 <h3>Return Values</h3>
  41 <blockquote>
  42 <li>
  43 0 is always returned.</li>
  44 </blockquote>
  45 <p>
  46
  47 <br><br>
  48 <hr noshade>
  49 <table border=0 width=100%>
  50 <tr valign=top>
  51 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
  52 <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>
  53 </tr><tr>
  54 <td><p class=tiny>libogg documentation</p></td>
  55 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
  56 </tr>
  57 </table>
  58
  59
  60 </body>
  61
  62 </html>