00001 <html>
00002
00003 <head>
00004 <title>libogg - function - ogg_sync_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_sync_clear</h1>
00017
00018 <p><i>declared in "ogg/ogg.h";</i></p>
00019
00020 <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.
00021
00022 <br><br>
00023 <table border=0 color=black cellspacing=0 cellpadding=7>
00024 <tr bgcolor=#cccccc>
00025 <td>
00026 <pre><b>
00027 int ogg_sync_clear(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
00028 </b></pre>
00029 </td>
00030 </tr>
00031 </table>
00032
00033 <h3>Parameters</h3>
00034 <dl>
00035 <dt><i>oy</i></dt>
00036 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
00037 </dl>
00038
00039
00040 <h3>Return Values</h3>
00041 <blockquote>
00042 <li>
00043 0 is always returned.</li>
00044 </blockquote>
00045 <p>
00046
00047 <br><br>
00048 <hr noshade>
00049 <table border=0 width=100%>
00050 <tr valign=top>
00051 <td><p class=tiny>copyright © 2000 xiph.org</p></td>
00052 <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>
00053 </tr><tr>
00054 <td><p class=tiny>libogg documentation</p></td>
00055 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00056 </tr>
00057 </table>
00058
00059
00060 </body>
00061
00062 </html>
