annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_comment_clear.html @ 83:ae30d91d2ffe

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