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