xorg-server-1.4/hw/dmx/doc/html/dmxarg_8h.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html>
   3   <head>
   4     <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   5     <title>File Index</title>
   6     <link href="doxygen.css" rel="stylesheet" type="text/css">
   7   </head>
   8   <body>
   9 <!-- Generated by Doxygen 1.3.4 -->
  10 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
  11 <h1>dmxarg.h File Reference</h1>
  12 <p>
  13 <a href="dmxarg_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  14 <tr><td></td></tr>
  15 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
  16 <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="struct__dmxArg.html">dmxArg</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8h.html#a1">dmxArgCreate</a> (void)</td></tr>
  17
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8h.html#a2">dmxArgFree</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a)</td></tr>
  19
  20 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8h.html#a3">dmxArgAdd</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a, const  char *string)</td></tr>
  21
  22 <tr><td class="memItemLeft" nowrap align=right valign=top>const  char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8h.html#a4">dmxArgV</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a, int item)</td></tr>
  23
  24 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8h.html#a5">dmxArgC</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a)</td></tr>
  25
  26 <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="struct__dmxArg.html">dmxArg</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8h.html#a6">dmxArgParse</a> (const  char *string)</td></tr>
  27
  28 </table>
  29 <hr><a name="_details"></a><h2>Detailed Description</h2>
  30 Interface to argument handling functions. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxarg_8c.html">dmxarg.c</a></dd></dl>
  31 <hr><h2>Function Documentation</h2>
  32 <a class="anchor" name="a3" doxytag="dmxarg.h::dmxArgAdd" ></a><p>
  33 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  34   <tr>
  35     <td class="mdRow">
  36       <table cellpadding="0" cellspacing="0" border="0">
  37         <tr>
  38           <td class="md" nowrap valign="top"> void dmxArgAdd </td>
  39           <td class="md" valign="top">(&nbsp;</td>
  40           <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a>&nbsp;</td>
  41           <td class="mdname" nowrap> <em>a</em>, </td>
  42         </tr>
  43         <tr>
  44           <td></td>
  45           <td></td>
  46           <td class="md" nowrap>const char *&nbsp;</td>
  47           <td class="mdname" nowrap> <em>string</em></td>
  48         </tr>
  49         <tr>
  50           <td></td>
  51           <td class="md">)&nbsp;</td>
  52           <td class="md" colspan="2"></td>
  53         </tr>
  54
  55       </table>
  56     </td>
  57   </tr>
  58 </table>
  59 <table cellspacing=5 cellpadding=0 border=0>
  60   <tr>
  61     <td>
  62       &nbsp;
  63     </td>
  64     <td>
  65
  66 <p>
  67 Add the <em>string</em> as the next argument in the <em>dmxArg</em> object.     </td>
  68   </tr>
  69 </table>
  70 <a class="anchor" name="a5" doxytag="dmxarg.h::dmxArgC" ></a><p>
  71 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  72   <tr>
  73     <td class="mdRow">
  74       <table cellpadding="0" cellspacing="0" border="0">
  75         <tr>
  76           <td class="md" nowrap valign="top"> int dmxArgC </td>
  77           <td class="md" valign="top">(&nbsp;</td>
  78           <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a>&nbsp;</td>
  79           <td class="mdname1" valign="top" nowrap> <em>a</em>          </td>
  80           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  81           <td class="md" nowrap></td>
  82         </tr>
  83
  84       </table>
  85     </td>
  86   </tr>
  87 </table>
  88 <table cellspacing=5 cellpadding=0 border=0>
  89   <tr>
  90     <td>
  91       &nbsp;
  92     </td>
  93     <td>
  94
  95 <p>
  96 Return the number of arguments in the <em>dmxArg</em> object.     </td>
  97   </tr>
  98 </table>
  99 <a class="anchor" name="a1" doxytag="dmxarg.h::dmxArgCreate" ></a><p>
 100 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 101   <tr>
 102     <td class="mdRow">
 103       <table cellpadding="0" cellspacing="0" border="0">
 104         <tr>
 105           <td class="md" nowrap valign="top"> <a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgCreate </td>
 106           <td class="md" valign="top">(&nbsp;</td>
 107           <td class="md" nowrap valign="top">void&nbsp;</td>
 108           <td class="mdname1" valign="top" nowrap>          </td>
 109           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 110           <td class="md" nowrap></td>
 111         </tr>
 112
 113       </table>
 114     </td>
 115   </tr>
 116 </table>
 117 <table cellspacing=5 cellpadding=0 border=0>
 118   <tr>
 119     <td>
 120       &nbsp;
 121     </td>
 122     <td>
 123
 124 <p>
 125 Create an (externally opaque) <em>dmxArg</em> object.     </td>
 126   </tr>
 127 </table>
 128 <a class="anchor" name="a2" doxytag="dmxarg.h::dmxArgFree" ></a><p>
 129 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 130   <tr>
 131     <td class="mdRow">
 132       <table cellpadding="0" cellspacing="0" border="0">
 133         <tr>
 134           <td class="md" nowrap valign="top"> void dmxArgFree </td>
 135           <td class="md" valign="top">(&nbsp;</td>
 136           <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a>&nbsp;</td>
 137           <td class="mdname1" valign="top" nowrap> <em>a</em>          </td>
 138           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 139           <td class="md" nowrap></td>
 140         </tr>
 141
 142       </table>
 143     </td>
 144   </tr>
 145 </table>
 146 <table cellspacing=5 cellpadding=0 border=0>
 147   <tr>
 148     <td>
 149       &nbsp;
 150     </td>
 151     <td>
 152
 153 <p>
 154 Free the specified <em>dmxArg</em> object.     </td>
 155   </tr>
 156 </table>
 157 <a class="anchor" name="a6" doxytag="dmxarg.h::dmxArgParse" ></a><p>
 158 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 159   <tr>
 160     <td class="mdRow">
 161       <table cellpadding="0" cellspacing="0" border="0">
 162         <tr>
 163           <td class="md" nowrap valign="top"> <a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgParse </td>
 164           <td class="md" valign="top">(&nbsp;</td>
 165           <td class="md" nowrap valign="top">const char *&nbsp;</td>
 166           <td class="mdname1" valign="top" nowrap> <em>string</em>          </td>
 167           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 168           <td class="md" nowrap></td>
 169         </tr>
 170
 171       </table>
 172     </td>
 173   </tr>
 174 </table>
 175 <table cellspacing=5 cellpadding=0 border=0>
 176   <tr>
 177     <td>
 178       &nbsp;
 179     </td>
 180     <td>
 181
 182 <p>
 183 Parse a string into arguments delimited by commas. Return a new <em>dmxArg</em> object containing the arguments.     </td>
 184   </tr>
 185 </table>
 186 <a class="anchor" name="a4" doxytag="dmxarg.h::dmxArgV" ></a><p>
 187 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 188   <tr>
 189     <td class="mdRow">
 190       <table cellpadding="0" cellspacing="0" border="0">
 191         <tr>
 192           <td class="md" nowrap valign="top"> const char* dmxArgV </td>
 193           <td class="md" valign="top">(&nbsp;</td>
 194           <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a>&nbsp;</td>
 195           <td class="mdname" nowrap> <em>a</em>, </td>
 196         </tr>
 197         <tr>
 198           <td></td>
 199           <td></td>
 200           <td class="md" nowrap>int&nbsp;</td>
 201           <td class="mdname" nowrap> <em>item</em></td>
 202         </tr>
 203         <tr>
 204           <td></td>
 205           <td class="md">)&nbsp;</td>
 206           <td class="md" colspan="2"></td>
 207         </tr>
 208
 209       </table>
 210     </td>
 211   </tr>
 212 </table>
 213 <table cellspacing=5 cellpadding=0 border=0>
 214   <tr>
 215     <td>
 216       &nbsp;
 217     </td>
 218     <td>
 219
 220 <p>
 221 Return the argument number <em>item</em> in the <em>dmxArg</em> object. Arguments are 0 based. NULL will be returned for values less than 0 or equal to or greater than the number of arguments in the object.     </td>
 222   </tr>
 223 </table>
 224     <hr>
 225     <address>
 226       <small>
 227         Generated June 29, 2004 for <a
 228         href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
 229         <a href="http://www.doxygen.org/index.html">doxygen</a>
 230         1.3.4.
 231       </small>
 232     </addres>
 233     </hr>
 234   </body>
 235 </html>