doc/libvorbis/vorbis_comment_add_tag.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_comment_add_tag</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_tag</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This function adds a tag-comment pair to a
  21 <a href="vorbis_comment.html">vorbis_comment</a> structure. There can
  22 be more than one comment value for the same tag; if a comment with the
  23 same tag already exists, another comment with the same tag is added.</p>
  24
  25 <p>If you already have a string in the form "KEY=value", see
  26 <a href="vorbis_comment_add.html">vorbis_comment_add</a> 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_tag(vorbis_comment *vc,
  33                                        const char *tag, const char *contents);
  34 </b></pre>
  35         </td>
  36 </tr>
  37 </table>
  38
  39 <h3>Parameters</h3>
  40 <dl>
  41 <dt><i>vc</i></dt>
  42 <dd>Pointer to a vorbis_comment structure to add the comment to.</dd>
  43 <dt><i>tag</i></dt>
  44 <dd>Pointer to the null-terminated tag string. The string will
  45 be copied, so it can be freed or modified after this function returns
  46 without affecting the vorbis_comment structure's contents.</dd>
  47 <dt><i>contents</i></dt>
  48 <dd>Pointer to the null-terminated comment contents string. This will
  49 also be copied.</dd>
  50 </dl>
  51
  52
  53 <h3>Return Values</h3>
  54 <blockquote>
  55 <li>None.</li>
  56 </blockquote>
  57 <p>
  58
  59 <br><br>
  60 <hr noshade>
  61 <table border=0 width=100%>
  62 <tr valign=top>
  63 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  64 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  65 </tr><tr>
  66 <td><p class=tiny>libvorbis documentation</p></td>
  67 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  68 </tr>
  69 </table>
  70
  71
  72 </body>
  73
  74 </html>