diff options
Diffstat (limited to 'doc/libvorbis/vorbis_comment_add.html')
-rw-r--r-- | doc/libvorbis/vorbis_comment_add.html | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/doc/libvorbis/vorbis_comment_add.html b/doc/libvorbis/vorbis_comment_add.html new file mode 100644 index 0000000..b7125b0 --- /dev/null +++ b/doc/libvorbis/vorbis_comment_add.html @@ -0,0 +1,70 @@ +<html> + +<head> +<title>libvorbis - function - vorbis_comment_add</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_add</h1> + +<p><i>declared in "vorbis/codec.h";</i></p> + +<p>This function adds a raw comment string to a +<a href="vorbis_comment.html">vorbis_comment</a> structure.</p> + +<p>This function should be used if the string is already in the +form "KEY=value". If you have a separate key and value, use +<a href="vorbis_comment_add_tag.html">vorbis_comment_add_tag</a> +instead.</p> + +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +extern void vorbis_comment_add(vorbis_comment *vc, const char *comment); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>vc</i></dt> +<dd>Pointer to a vorbis_comment structure to add the comment to.</dd> +<dt><i>comment</i></dt> +<dd>Pointer to the null-terminated raw comment string. The string will +be copied, so it can be freed or modified after this function returns +without affecting the vorbis_comment structure's contents.</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> |