ao/doc/ao_driver_info.html

   1 <html>
   2
   3 <head>
   4 <title>libao - function - ao_driver_info</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>libao documentation</p></td>
  12 <td align=right><p class=tiny>libao version 0.8.5 - 20040312</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ao_driver_info</h1>
  17
  18 <p><i>declared in "ao/ao.h";</i></p>
  19
  20 <p>Get information about a particular driver.
  21
  22 <br><br>
  23 <table border=0 color=black cellspacing=0 cellpadding=7>
  24 <tr bgcolor=#cccccc>
  25         <td>
  26 <pre><b>
  27 <a href="ao_info.html">ao_info</a>* ao_driver_info(int driver_id);
  28 </b></pre>
  29         </td>
  30 </tr>
  31 </table>
  32
  33 <h3>Parameters</h3>
  34 <dl>
  35 <dt><i>driver_id</i></dt>
  36 <dd>The ID number of the driver as returned by either
  37 <a href="ao_driver_id.html">ao_driver_id()</a> or
  38 <a href="ao_default_driver_id.html">ao_default_driver_id()</a>.</dd>
  39 </dl>
  40
  41 <h3>Return Values</h3>
  42 <blockquote>
  43 <li>
  44 non-NULL pointer inicates success.  It points to a static info structure that
  45 should not be modified under any circumstances.</li>
  46
  47 <li>NULL indicates failure because <tt>driver_id</tt> does not correspond to
  48 an actual driver</li>
  49 </blockquote>
  50 <p>
  51
  52 <br><br>
  53 <hr noshade>
  54 <table border=0 width=100%>
  55 <tr valign=top>
  56 <td><p class=tiny>copyright &copy; 2001-2003 Stan Seibert</p></td>
  57 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:volsung@xiph.org">volsung@xiph.org</a></p></td>
  58 </tr><tr>
  59 <td><p class=tiny>libao documentation</p></td>
  60 <td align=right><p class=tiny>libao version 0.8.5 - 20040312</p></td>
  61 </tr>
  62 </table>
  63
  64 </body>
  65
  66 </html>