diff options
| author | Aki <please@ignore.pl> | 2021-09-29 22:52:49 +0200 |
|---|---|---|
| committer | Aki <please@ignore.pl> | 2021-09-29 22:52:49 +0200 |
| commit | 74f4b1bc3b627ba4c7e03498234d88cacdfbe97b (patch) | |
| tree | 197b5978d6e38f44069ea92583098a1da04aa635 /doc/libvorbis/vorbis_comment_clear.html | |
| download | starshatter-74f4b1bc3b627ba4c7e03498234d88cacdfbe97b.zip starshatter-74f4b1bc3b627ba4c7e03498234d88cacdfbe97b.tar.gz starshatter-74f4b1bc3b627ba4c7e03498234d88cacdfbe97b.tar.bz2 | |
Squashed 'vorbis/' content from commit d22c3ab5f
git-subtree-dir: vorbis
git-subtree-split: d22c3ab5f633460abc2532feee60ca0892134cbf
Diffstat (limited to 'doc/libvorbis/vorbis_comment_clear.html')
| -rw-r--r-- | doc/libvorbis/vorbis_comment_clear.html | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/libvorbis/vorbis_comment_clear.html b/doc/libvorbis/vorbis_comment_clear.html new file mode 100644 index 0000000..0771d6e --- /dev/null +++ b/doc/libvorbis/vorbis_comment_clear.html @@ -0,0 +1,69 @@ +<html> + +<head> +<title>libvorbis - function - vorbis_comment_clear</title> +<link rel=stylesheet href="style.css" type="text/css"> +</head> + +<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> +<table border=0 width=100%> +<tr> +<td><p class=tiny>libvorbis documentation</p></td> +<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> +</tr> +</table> + +<h1>vorbis_comment_clear</h1> + +<p><i>declared in "vorbis/codec.h";</i></p> + +<p>This function frees the internal storage associated with a <a href="vorbis_comment.html">vorbis_comment</a> structure.</p> + +<p><i>Note:</i> Be careful if you have modified the vorbis_comment +structure yourself, as libvorbis will try to use its own wrappers of +memory allocation functions to free the contents of the vorbis_comment +structure. This will not work correctly unless all arrays and comment +strings contained in the vorbis_comment structure were allocated by +libvorbis itself. This function is only guaranteed to be safe if all +modification to the vorbis_comment structure was done using libvorbis +functions.</p> + +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +extern void vorbis_comment_clear(vorbis_comment *vc); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>vc</i></dt> +<dd>The vorbis_comment structure to clear.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li>None.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> +</tr><tr> +<td><p class=tiny>libvorbis documentation</p></td> +<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> +</tr> +</table> + + +</body> + +</html> |