vorbis_comment_add.html 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <html>
  2. <head>
  3. <title>libvorbis - function - vorbis_comment_add</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_add</h1>
  14. <p><i>declared in "vorbis/codec.h";</i></p>
  15. <p>This function adds a raw comment string to a
  16. <a href="vorbis_comment.html">vorbis_comment</a> structure.</p>
  17. <p>This function should be used if the string is already in the
  18. form "KEY=value". If you have a separate key and value, use
  19. <a href="vorbis_comment_add_tag.html">vorbis_comment_add_tag</a>
  20. instead.</p>
  21. <table border=0 color=black cellspacing=0 cellpadding=7>
  22. <tr bgcolor=#cccccc>
  23. <td>
  24. <pre><b>
  25. extern void vorbis_comment_add(vorbis_comment *vc, const char *comment);
  26. </b></pre>
  27. </td>
  28. </tr>
  29. </table>
  30. <h3>Parameters</h3>
  31. <dl>
  32. <dt><i>vc</i></dt>
  33. <dd>Pointer to a vorbis_comment structure to add the comment to.</dd>
  34. <dt><i>comment</i></dt>
  35. <dd>Pointer to the null-terminated raw comment string. The string will
  36. be copied, so it can be freed or modified after this function returns
  37. without affecting the vorbis_comment structure's contents.</dd>
  38. </dl>
  39. <h3>Return Values</h3>
  40. <blockquote>
  41. <li>None.</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; 2010 Xiph.Org</p></td>
  49. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  50. </tr><tr>
  51. <td><p class=tiny>libvorbis documentation</p></td>
  52. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  53. </tr>
  54. </table>
  55. </body>
  56. </html>