4 <title>libogg - function - ogg_sync_destroy</title>
5 <link rel=stylesheet href="style.css" type="text/css">
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9 <table border=0 width=100%>
11 <td><p class=tiny>libogg documentation</p></td>
12 <td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
16 <h1>ogg_sync_destroy</h1>
18 <p><i>declared in "ogg/ogg.h";</i></p>
20 <p>This function is used to destroy an <a href="ogg_sync_state.html">ogg_sync_state</a> struct and free all memory used.</p>
22 <p>Note this calls free() on its argument so you should only use this
23 function if you've allocated the ogg_sync_state on the heap. If it is
24 allocated on the stack, or it will otherwise be freed by your
25 own code, use <a href="ogg_sync_clear.html">ogg_sync_clear</a> instead
26 to release just the internal memory.</p>
29 <table border=0 color=black cellspacing=0 cellpadding=7>
33 int ogg_sync_destroy(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
42 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
46 <h3>Return Values</h3>
49 0 is always returned.</li>
55 <table border=0 width=100%>
57 <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td>
58 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
60 <td><p class=tiny>libogg documentation</p></td>
61 <td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>