1 <html> 2 3 <head> 4 <title>libogg - function - ogg_stream_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_stream_destroy</h1> 17 18 <p><i>declared in "ogg/ogg.h";</i></p> 19 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. 23 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> 26 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> 30 31 <br><br> 32 <table border=0 color=black cellspacing=0 cellpadding=7> 33 <tr bgcolor=#cccccc> 34 <td> 35 <pre><b> 36 int ogg_stream_destroy(ogg_stream_state *os); 37 </b></pre> 38 </td> 39 </tr> 40 </table> 41 42 <h3>Parameters</h3> 43 <dl> 44 <dt><i>os</i></dt> 45 <dd>Pointer to the ogg_stream_state struct to be destroyed.</dd> 46 </dl> 47 48 49 <h3>Return Values</h3> 50 <blockquote> 51 <li> 52 0 is always returned.</li> 53 </blockquote> 54 <p> 55 56 <br><br> 57 <hr noshade> 58 <table border=0 width=100%> 59 <tr valign=top> 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> 62 </tr><tr> 63 <td><p class=tiny>libogg documentation</p></td> 64 <td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td> 65 </tr> 66 </table> 67 68 69 </body> 70 71 </html> 72
