vorbis_comment_clear.html 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. <html>
  2. <head>
  3. <title>libvorbis - function - vorbis_comment_clear</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>libvorbis documentation</p></td>
  10. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  11. </tr>
  12. </table>
  13. <h1>vorbis_comment_clear</h1>
  14. <p><i>declared in "vorbis/codec.h";</i></p>
  15. <p>This function frees the internal storage associated with a <a href="vorbis_comment.html">vorbis_comment</a> structure.</p>
  16. <p><i>Note:</i> Be careful if you have modified the vorbis_comment
  17. structure yourself, as libvorbis will try to use its own wrappers of
  18. memory allocation functions to free the contents of the vorbis_comment
  19. structure. This will not work correctly unless all arrays and comment
  20. strings contained in the vorbis_comment structure were allocated by
  21. libvorbis itself. This function is only guaranteed to be safe if all
  22. modification to the vorbis_comment structure was done using libvorbis
  23. functions.</p>
  24. <table border=0 color=black cellspacing=0 cellpadding=7>
  25. <tr bgcolor=#cccccc>
  26. <td>
  27. <pre><b>
  28. extern void vorbis_comment_clear(vorbis_comment *vc);
  29. </b></pre>
  30. </td>
  31. </tr>
  32. </table>
  33. <h3>Parameters</h3>
  34. <dl>
  35. <dt><i>vc</i></dt>
  36. <dd>The vorbis_comment structure to clear.</dd>
  37. </dl>
  38. <h3>Return Values</h3>
  39. <blockquote>
  40. <li>None.</li>
  41. </blockquote>
  42. <p>
  43. <br><br>
  44. <hr noshade>
  45. <table border=0 width=100%>
  46. <tr valign=top>
  47. <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  48. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  49. </tr><tr>
  50. <td><p class=tiny>libvorbis documentation</p></td>
  51. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  52. </tr>
  53. </table>
  54. </body>
  55. </html>