4 <title>libogg - function - ogg_stream_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_stream_destroy</h1>
18 <p><i>declared in "ogg/ogg.h";</i></p>
20 <p>This function frees the internal memory used by
21 the <a href="ogg_stream_state.html">ogg_stream_state</a> struct as
22 well as the structure itself.
24 <p>This should be called when you are done working with an ogg stream.
25 It can also be called to make sure that the struct does not exist.</p>
27 <p>It calls free() on its argument, so if the ogg_stream_state
28 is not malloc()'d or will otherwise be freed by your own code, use
29 <a href="ogg_stream_clear.html">ogg_stream_clear</a> instead.</p>
32 <table border=0 color=black cellspacing=0 cellpadding=7>
36 int ogg_stream_destroy(ogg_stream_state *os);
45 <dd>Pointer to the ogg_stream_state struct to be destroyed.</dd>
49 <h3>Return Values</h3>
52 0 is always returned.</li>
58 <table border=0 width=100%>
60 <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td>
61 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
63 <td><p class=tiny>libogg documentation</p></td>
64 <td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>