Mercurial > hg > sv-dependency-builds
comparison src/libvorbis-1.3.3/doc/libvorbis/vorbis_comment_query.html @ 86:98c1576536ae
Bring in flac, ogg, vorbis
| author | Chris Cannam <cannam@all-day-breakfast.com> |
|---|---|
| date | Tue, 19 Mar 2013 17:37:49 +0000 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 85:545efbb81310 | 86:98c1576536ae |
|---|---|
| 1 <html> | |
| 2 | |
| 3 <head> | |
| 4 <title>libvorbis - function - vorbis_comment_query</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_query</h1> | |
| 17 | |
| 18 <p><i>declared in "vorbis/codec.h";</i></p> | |
| 19 | |
| 20 <p>This function retrieves a comment string for a given tag in a | |
| 21 <a href="vorbis_comment.html">vorbis_comment</a> structure.</p> | |
| 22 | |
| 23 <table border=0 color=black cellspacing=0 cellpadding=7> | |
| 24 <tr bgcolor=#cccccc> | |
| 25 <td> | |
| 26 <pre><b> | |
| 27 extern char *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count); | |
| 28 </b></pre> | |
| 29 </td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 | |
| 33 <h3>Parameters</h3> | |
| 34 <dl> | |
| 35 <dt><i>vc</i></dt> | |
| 36 <dd>Pointer to the vorbis_comment structure.</dd> | |
| 37 <dt><i>tag</i></dt> | |
| 38 <dd>Pointer to a null-terminated string of the comment tag to look | |
| 39 for. Tags are compared case-insensitively.</dd> | |
| 40 <dt><i>count</i></dt> | |
| 41 <dd>The index of the comment string to retrieve. A value of 0 indicates | |
| 42 the first comment whose tag matches <i>tag</i>. Use | |
| 43 <a href="vorbis_comment_query_count.html">vorbis_comment_query_count</a> | |
| 44 to determine the number of matching comments.</dd> | |
| 45 </dl> | |
| 46 | |
| 47 | |
| 48 <h3>Return Values</h3> | |
| 49 <blockquote> | |
| 50 <li>A pointer to the comment string. The underlying buffer is owned by | |
| 51 the vorbis_comment structure.</li> | |
| 52 <li>NULL on a nonexistent tag or if <i>count</i> is greater than or | |
| 53 equal to the number of matching comments.</li> | |
| 54 </blockquote> | |
| 55 <p> | |
| 56 | |
| 57 <br><br> | |
| 58 <hr noshade> | |
| 59 <table border=0 width=100%> | |
| 60 <tr valign=top> | |
| 61 <td><p class=tiny>copyright © 2010 Xiph.Org</p></td> | |
| 62 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> | |
| 63 </tr><tr> | |
| 64 <td><p class=tiny>libvorbis documentation</p></td> | |
| 65 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> | |
| 66 </tr> | |
| 67 </table> | |
| 68 | |
| 69 | |
| 70 </body> | |
| 71 | |
| 72 </html> |