Chris@1
|
1 <html>
|
Chris@1
|
2
|
Chris@1
|
3 <head>
|
Chris@1
|
4 <title>libogg - function - ogg_stream_destroy</title>
|
Chris@1
|
5 <link rel=stylesheet href="style.css" type="text/css">
|
Chris@1
|
6 </head>
|
Chris@1
|
7
|
Chris@1
|
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
|
Chris@1
|
9 <table border=0 width=100%>
|
Chris@1
|
10 <tr>
|
Chris@1
|
11 <td><p class=tiny>libogg documentation</p></td>
|
Chris@1
|
12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
Chris@1
|
13 </tr>
|
Chris@1
|
14 </table>
|
Chris@1
|
15
|
Chris@1
|
16 <h1>ogg_stream_destroy</h1>
|
Chris@1
|
17
|
Chris@1
|
18 <p><i>declared in "ogg/ogg.h";</i></p>
|
Chris@1
|
19
|
Chris@1
|
20 <p>This function frees the internal memory used by
|
Chris@1
|
21 the <a href="ogg_stream_state.html">ogg_stream_state</a> struct as
|
Chris@1
|
22 well as the structure itself.
|
Chris@1
|
23
|
Chris@1
|
24 <p>This should be called when you are done working with an ogg stream.
|
Chris@1
|
25 It can also be called to make sure that the struct does not exist.</p>
|
Chris@1
|
26
|
Chris@1
|
27 <p>It calls free() on its argument, so if the ogg_stream_state
|
Chris@1
|
28 is not malloc()'d or will otherwise be freed by your own code, use
|
Chris@1
|
29 <a href="ogg_stream_clear.html">ogg_stream_clear</a> instead.</p>
|
Chris@1
|
30
|
Chris@1
|
31 <br><br>
|
Chris@1
|
32 <table border=0 color=black cellspacing=0 cellpadding=7>
|
Chris@1
|
33 <tr bgcolor=#cccccc>
|
Chris@1
|
34 <td>
|
Chris@1
|
35 <pre><b>
|
Chris@1
|
36 int ogg_stream_destroy(ogg_stream_state *os);
|
Chris@1
|
37 </b></pre>
|
Chris@1
|
38 </td>
|
Chris@1
|
39 </tr>
|
Chris@1
|
40 </table>
|
Chris@1
|
41
|
Chris@1
|
42 <h3>Parameters</h3>
|
Chris@1
|
43 <dl>
|
Chris@1
|
44 <dt><i>os</i></dt>
|
Chris@1
|
45 <dd>Pointer to the ogg_stream_state struct to be destroyed.</dd>
|
Chris@1
|
46 </dl>
|
Chris@1
|
47
|
Chris@1
|
48
|
Chris@1
|
49 <h3>Return Values</h3>
|
Chris@1
|
50 <blockquote>
|
Chris@1
|
51 <li>
|
Chris@1
|
52 0 is always returned.</li>
|
Chris@1
|
53 </blockquote>
|
Chris@1
|
54 <p>
|
Chris@1
|
55
|
Chris@1
|
56 <br><br>
|
Chris@1
|
57 <hr noshade>
|
Chris@1
|
58 <table border=0 width=100%>
|
Chris@1
|
59 <tr valign=top>
|
Chris@1
|
60 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td>
|
Chris@1
|
61 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
Chris@1
|
62 </tr><tr>
|
Chris@1
|
63 <td><p class=tiny>libogg documentation</p></td>
|
Chris@1
|
64 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
Chris@1
|
65 </tr>
|
Chris@1
|
66 </table>
|
Chris@1
|
67
|
Chris@1
|
68
|
Chris@1
|
69 </body>
|
Chris@1
|
70
|
Chris@1
|
71 </html>
|