doc/libvorbis/vorbis_comment_init.html

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