doc/libvorbis/vorbis_comment_add.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_comment_add</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>libvorbis documentation</p></td>
  12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>vorbis_comment_add</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This function adds a raw comment string to a
  21 <a href="vorbis_comment.html">vorbis_comment</a> structure.</p>
  22
  23 <p>This function should be used if the string is already in the
  24 form "KEY=value". If you have a separate key and value, use
  25 <a href="vorbis_comment_add_tag.html">vorbis_comment_add_tag</a>
  26 instead.</p>
  27
  28 <table border=0 color=black cellspacing=0 cellpadding=7>
  29 <tr bgcolor=#cccccc>
  30         <td>
  31 <pre><b>
  32 extern void     vorbis_comment_add(vorbis_comment *vc, const char *comment);
  33 </b></pre>
  34         </td>
  35 </tr>
  36 </table>
  37
  38 <h3>Parameters</h3>
  39 <dl>
  40 <dt><i>vc</i></dt>
  41 <dd>Pointer to a vorbis_comment structure to add the comment to.</dd>
  42 <dt><i>comment</i></dt>
  43 <dd>Pointer to the null-terminated raw comment string. The string will
  44 be copied, so it can be freed or modified after this function returns
  45 without affecting the vorbis_comment structure's contents.</dd>
  46 </dl>
  47
  48
  49 <h3>Return Values</h3>
  50 <blockquote>
  51 <li>None.</li>
  52 </blockquote>
  53 <p>
  54
  55 <br><br>
  56 <hr noshade>
  57 <table border=0 width=100%>
  58 <tr valign=top>
  59 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  60 <td align=right><p class=tiny><a href="https://xiph.org/vorbis/index.html">Ogg Vorbis</a></p></td>
  61 </tr><tr>
  62 <td><p class=tiny>libvorbis documentation</p></td>
  63 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  64 </tr>
  65 </table>
  66
  67
  68 </body>
  69
  70 </html>