1<html>
2
3<head>
4<title>libogg - function - ogg_sync_destroy</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.2.0 - 20100325</p></td>
13</tr>
14</table>
15
16<h1>ogg_sync_destroy</h1>
17
18<p><i>declared in "ogg/ogg.h";</i></p>
19
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>
21
22<p>Note this calls free() on its argument so you should only use this
23function if you've allocated the ogg_sync_state on the heap. If it is
24allocated on the stack, or it will otherwise be freed by your
25own code, use <a href="ogg_sync_clear.html">ogg_sync_clear</a> instead
26to release just the internal memory.</p>
27
28<br><br>
29<table border=0 color=black cellspacing=0 cellpadding=7>
30<tr bgcolor=#cccccc>
31	<td>
32<pre><b>
33int ogg_sync_destroy(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
34</b></pre>
35	</td>
36</tr>
37</table>
38
39<h3>Parameters</h3>
40<dl>
41<dt><i>oy</i></dt>
42<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
43</dl>
44
45
46<h3>Return Values</h3>
47<blockquote>
48<li>
490 is always returned.</li>
50</blockquote>
51<p>
52
53<br><br>
54<hr noshade>
55<table border=0 width=100%>
56<tr valign=top>
57<td><p class=tiny>copyright &copy; 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>
59</tr><tr>
60<td><p class=tiny>libogg documentation</p></td>
61<td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
62</tr>
63</table>
64
65
66</body>
67
68</html>
69