Mercurial > hg > sv-dependency-builds

diff src/libvorbis-1.3.3/doc/libvorbis/vorbis_comment_query.html @ 1:05aa0afa9217

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Bring in flac, ogg, vorbis
author Chris Cannam
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/libvorbis-1.3.3/doc/libvorbis/vorbis_comment_query.html	Tue Mar 19 17:37:49 2013 +0000
@@ -0,0 +1,72 @@
+<html>
+
+<head>
+<title>libvorbis - function - vorbis_comment_query</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_query</h1>
+
+<p><i>declared in "vorbis/codec.h";</i></p>
+
+<p>This function retrieves a comment string for a given tag in a
+<a href="vorbis_comment.html">vorbis_comment</a> structure.</p>
+
+<table border=0 color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+	<td>
+<pre><b>
+extern char    *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count);
+</b></pre>
+	</td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>vc</i></dt>
+<dd>Pointer to the vorbis_comment structure.</dd>
+<dt><i>tag</i></dt>
+<dd>Pointer to a null-terminated string of the comment tag to look
+for. Tags are compared case-insensitively.</dd>
+<dt><i>count</i></dt>
+<dd>The index of the comment string to retrieve. A value of 0 indicates
+the first comment whose tag matches <i>tag</i>. Use
+<a href="vorbis_comment_query_count.html">vorbis_comment_query_count</a>
+to determine the number of matching comments.</dd>
+</dl>
+
+
+<h3>Return Values</h3>
+<blockquote>
+<li>A pointer to the comment string. The underlying buffer is owned by
+the vorbis_comment structure.</li>
+<li>NULL on a nonexistent tag or if <i>count</i> is greater than or
+equal to the number of matching comments.</li>
+</blockquote>
+<p>
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright &copy; 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>