ao/doc/ao_plugin_set_option.html

   1 <html>
   2
   3 <head>
   4 <title>libao - function - ao_plugin_set_option</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_plugin_set_option</h1>
  17
  18 <p><i>declared in "ao/plugin.h";</i></p>
  19
  20 <p>Set a new option key-value pair for a device.  This will only be
  21 called after <a
  22 href="ao_plugin_device_init.html">ao_plugin_device_init()</a> is called.
  23 Unrecognized option keys are silently ignored, but invalid option
  24 values will cause the function to return a failing error code.
  25
  26 <br><br>
  27 <table border=0 color=black cellspacing=0 cellpadding=7>
  28 <tr bgcolor=#cccccc>
  29         <td>
  30 <pre><b>
  31 int ao_plugin_set_option(<a href="ao_device.html">ao_device</a> *device, const char *key, const char *value);
  32 </b></pre>
  33         </td>
  34 </tr>
  35 </table>
  36
  37 <h3>Parameters</h3>
  38 <dl>
  39 <dt><i>device</i></dt>
  40 <dd>Pointer to the device structure.</dd>
  41 <dt><i>key</i></dt>
  42 <dd>A string holding the option key.  The calling function retains ownership
  43 of this memory.</dd>
  44 <dt><i>value</i></dt>
  45 <dd>A string holding the option value.  The calling function retains ownership
  46 of this memory.</dd>
  47 </dl>
  48
  49 <h3>Return Values</h3>
  50 <blockquote>
  51 <li>1 indicates success.</li>
  52
  53 <li>0 indicates failure.  <a
  54 href="ao_plugin_device_clear.html">ao_plugin_device_clear()</a> should be
  55 called to ensure the deallocate of all private data structures.</li>
  56 </blockquote>
  57 <p>
  58
  59 <br><br>
  60 <hr noshade>
  61 <table border=0 width=100%>
  62 <tr valign=top>
  63 <td><p class=tiny>copyright &copy; 2001-2003 Stan Seibert</p></td>
  64 <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>
  65 </tr><tr>
  66 <td><p class=tiny>libao documentation</p></td>
  67 <td align=right><p class=tiny>libao version 0.8.5 - 20040312</p></td>
  68 </tr>
  69 </table>
  70
  71 </body>
  72
  73 </html>