ogg_stream_destroy.html 1.7 KB

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