vorbis_comment_query.html 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. <html>
  2. <head>
  3. <title>libvorbis - function - vorbis_comment_query</title>
  4. <link rel=stylesheet href="style.css" type="text/css">
  5. </head>
  6. <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
  7. <table border=0 width=100%>
  8. <tr>
  9. <td><p class=tiny>libvorbis documentation</p></td>
  10. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  11. </tr>
  12. </table>
  13. <h1>vorbis_comment_query</h1>
  14. <p><i>declared in "vorbis/codec.h";</i></p>
  15. <p>This function retrieves a comment string for a given tag in a
  16. <a href="vorbis_comment.html">vorbis_comment</a> structure.</p>
  17. <table border=0 color=black cellspacing=0 cellpadding=7>
  18. <tr bgcolor=#cccccc>
  19. <td>
  20. <pre><b>
  21. extern char *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count);
  22. </b></pre>
  23. </td>
  24. </tr>
  25. </table>
  26. <h3>Parameters</h3>
  27. <dl>
  28. <dt><i>vc</i></dt>
  29. <dd>Pointer to the vorbis_comment structure.</dd>
  30. <dt><i>tag</i></dt>
  31. <dd>Pointer to a null-terminated string of the comment tag to look
  32. for. Tags are compared case-insensitively.</dd>
  33. <dt><i>count</i></dt>
  34. <dd>The index of the comment string to retrieve. A value of 0 indicates
  35. the first comment whose tag matches <i>tag</i>. Use
  36. <a href="vorbis_comment_query_count.html">vorbis_comment_query_count</a>
  37. to determine the number of matching comments.</dd>
  38. </dl>
  39. <h3>Return Values</h3>
  40. <blockquote>
  41. <li>A pointer to the comment string. The underlying buffer is owned by
  42. the vorbis_comment structure.</li>
  43. <li>NULL on a nonexistent tag or if <i>count</i> is greater than or
  44. equal to the number of matching comments.</li>
  45. </blockquote>
  46. <p>
  47. <br><br>
  48. <hr noshade>
  49. <table border=0 width=100%>
  50. <tr valign=top>
  51. <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  52. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  53. </tr><tr>
  54. <td><p class=tiny>libvorbis documentation</p></td>
  55. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  56. </tr>
  57. </table>
  58. </body>
  59. </html>