Mercurial > hg > sv-dependency-builds
annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_comment_clear.html @ 86:98c1576536ae
Bring in flac, ogg, vorbis
| author | Chris Cannam <cannam@all-day-breakfast.com> |
|---|---|
| date | Tue, 19 Mar 2013 17:37:49 +0000 |
| parents | |
| children |
| rev | line source |
|---|---|
| cannam@86 | 1 <html> |
| cannam@86 | 2 |
| cannam@86 | 3 <head> |
| cannam@86 | 4 <title>libvorbis - function - vorbis_comment_clear</title> |
| cannam@86 | 5 <link rel=stylesheet href="style.css" type="text/css"> |
| cannam@86 | 6 </head> |
| cannam@86 | 7 |
| cannam@86 | 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
| cannam@86 | 9 <table border=0 width=100%> |
| cannam@86 | 10 <tr> |
| cannam@86 | 11 <td><p class=tiny>libvorbis documentation</p></td> |
| cannam@86 | 12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> |
| cannam@86 | 13 </tr> |
| cannam@86 | 14 </table> |
| cannam@86 | 15 |
| cannam@86 | 16 <h1>vorbis_comment_clear</h1> |
| cannam@86 | 17 |
| cannam@86 | 18 <p><i>declared in "vorbis/codec.h";</i></p> |
| cannam@86 | 19 |
| cannam@86 | 20 <p>This function frees the internal storage associated with a <a href="vorbis_comment.html">vorbis_comment</a> structure.</p> |
| cannam@86 | 21 |
| cannam@86 | 22 <p><i>Note:</i> Be careful if you have modified the vorbis_comment |
| cannam@86 | 23 structure yourself, as libvorbis will try to use its own wrappers of |
| cannam@86 | 24 memory allocation functions to free the contents of the vorbis_comment |
| cannam@86 | 25 structure. This will not work correctly unless all arrays and comment |
| cannam@86 | 26 strings contained in the vorbis_comment structure were allocated by |
| cannam@86 | 27 libvorbis itself. This function is only guaranteed to be safe if all |
| cannam@86 | 28 modification to the vorbis_comment structure was done using libvorbis |
| cannam@86 | 29 functions.</p> |
| cannam@86 | 30 |
| cannam@86 | 31 <table border=0 color=black cellspacing=0 cellpadding=7> |
| cannam@86 | 32 <tr bgcolor=#cccccc> |
| cannam@86 | 33 <td> |
| cannam@86 | 34 <pre><b> |
| cannam@86 | 35 extern void vorbis_comment_clear(vorbis_comment *vc); |
| cannam@86 | 36 </b></pre> |
| cannam@86 | 37 </td> |
| cannam@86 | 38 </tr> |
| cannam@86 | 39 </table> |
| cannam@86 | 40 |
| cannam@86 | 41 <h3>Parameters</h3> |
| cannam@86 | 42 <dl> |
| cannam@86 | 43 <dt><i>vc</i></dt> |
| cannam@86 | 44 <dd>The vorbis_comment structure to clear.</dd> |
| cannam@86 | 45 </dl> |
| cannam@86 | 46 |
| cannam@86 | 47 |
| cannam@86 | 48 <h3>Return Values</h3> |
| cannam@86 | 49 <blockquote> |
| cannam@86 | 50 <li>None.</li> |
| cannam@86 | 51 </blockquote> |
| cannam@86 | 52 <p> |
| cannam@86 | 53 |
| cannam@86 | 54 <br><br> |
| cannam@86 | 55 <hr noshade> |
| cannam@86 | 56 <table border=0 width=100%> |
| cannam@86 | 57 <tr valign=top> |
| cannam@86 | 58 <td><p class=tiny>copyright © 2010 Xiph.Org</p></td> |
| cannam@86 | 59 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> |
| cannam@86 | 60 </tr><tr> |
| cannam@86 | 61 <td><p class=tiny>libvorbis documentation</p></td> |
| cannam@86 | 62 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> |
| cannam@86 | 63 </tr> |
| cannam@86 | 64 </table> |
| cannam@86 | 65 |
| cannam@86 | 66 |
| cannam@86 | 67 </body> |
| cannam@86 | 68 |
| cannam@86 | 69 </html> |