vorbis_comment_init.html 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. <html>
  2. <head>
  3. <title>libvorbis - function - vorbis_comment_init</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_init</h1>
  14. <p><i>declared in "vorbis/codec.h";</i></p>
  15. <p>This function initializes a <a href="vorbis_comment.html">vorbis_comment</a>
  16. structure for use. After calling this function, the vorbis_comment
  17. structure contains no comments.</p>
  18. <p><i>Note:</i> No internal storage is allocated by this function;
  19. internal storage is allocated as needed by other libvorbis functions that
  20. modify the vorbis_comment structure. If you modify the vorbis_comment
  21. structure directly, without using libvorbis, you should <i>not</i>
  22. call <a href="vorbis_comment_clear.html">vorbis_comment_clear</a> when
  23. you are finished but instead clean up after it yourself. See the note
  24. on the <a href="vorbis_comment_clear.html">vorbis_comment_clear</a>
  25. page for more information.</p>
  26. <table border=0 color=black cellspacing=0 cellpadding=7>
  27. <tr bgcolor=#cccccc>
  28. <td>
  29. <pre><b>
  30. extern void vorbis_comment_init(vorbis_comment *vc);
  31. </b></pre>
  32. </td>
  33. </tr>
  34. </table>
  35. <h3>Parameters</h3>
  36. <dl>
  37. <dt><i>vc</i></dt>
  38. <dd>Pointer to the <a href="vorbis_comment.html">vorbis_comment</a>
  39. structure to initialize.</dd>
  40. </dl>
  41. <h3>Return Values</h3>
  42. <blockquote>
  43. <li>None.</li>
  44. </blockquote>
  45. <p>
  46. <br><br>
  47. <hr noshade>
  48. <table border=0 width=100%>
  49. <tr valign=top>
  50. <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  51. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  52. </tr><tr>
  53. <td><p class=tiny>libvorbis documentation</p></td>
  54. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  55. </tr>
  56. </table>
  57. </body>
  58. </html>