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.7.4 --> 10 <div id="navrow1" class="tabs"> 11 <ul class="tablist"> 12 <li><a href="index.html"><span>Main Page</span></a></li> 13 <li><a href="annotated.html"><span>Data Structures</span></a></li> 14 <li class="current"><a href="files.html"><span>Files</span></a></li> 15 </ul> 16 </div> 17 <div id="navrow2" class="tabs2"> 18 <ul class="tablist"> 19 <li><a href="files.html"><span>File List</span></a></li> 20 <li><a href="globals.html"><span>Globals</span></a></li> 21 </ul> 22 </div> 23 </div> 24 <div id="side-nav" class="ui-resizable side-nav-resizable"> 25 <div id="nav-tree"> 26 <div id="nav-tree-contents"> 27 </div> 28 </div> 29 <div id="splitbar" style="-moz-user-select:none;" 30 class="ui-resizable-handle"> 31 </div> 32 </div> 33 <script type="text/javascript"> 34 initNavTree('dmxarg_8h.html',''); 35 </script> 36 <div id="doc-content"> 37 <div class="header"> 38 <div class="summary"> 39 <a href="#typedef-members">Typedefs</a> | 40 <a href="#func-members">Functions</a> </div> 41 <div class="headertitle"> 42 <div class="title">dmxarg.h File Reference</div> </div> 43 </div> 44 <div class="contents"> 45 46 <p><a href="dmxarg_8h_source.html">Go to the source code of this file.</a></p> 47 <table class="memberdecls"> 48 <tr><td colspan="2"><h2><a name="typedef-members"></a> 49 Typedefs</h2></td></tr> 50 <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__dmxArg.html">_dmxArg</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8h.html#a7f310ec1f9d20311533a2a142a0b92b8">dmxArg</a></td></tr> 51 <tr><td colspan="2"><h2><a name="func-members"></a> 52 Functions</h2></td></tr> 53 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8h.html#af4ecb9595303a7fcac5eae840766b6fb">dmxArgCreate</a> (void)</td></tr> 54 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8h.html#aa6b362f314787cc0e0fd7ca55b53a5cc">dmxArgFree</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a)</td></tr> 55 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8h.html#a6d41e61a00975e123ed72a269d653d23">dmxArgAdd</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a, const char *string)</td></tr> 56 <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8h.html#a7de14f607c61ecac05f9c45d002e36ab">dmxArgV</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a, int item)</td></tr> 57 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8h.html#a94e36fd228f49fb0a77c34709cbd3a69">dmxArgC</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a)</td></tr> 58 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8h.html#a7d872851e86ae8063cd13e85ed203d09">dmxArgParse</a> (const char *string)</td></tr> 59 </table> 60 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 61 <div class="textblock"><p>Interface to argument handling functions. </p> 62 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="dmxarg_8c.html">dmxarg.c</a> </dd></dl> 63 </div><hr/><h2>Typedef Documentation</h2> 64 <a class="anchor" id="a7f310ec1f9d20311533a2a142a0b92b8"></a><!-- doxytag: member="dmxarg.h::dmxArg" ref="a7f310ec1f9d20311533a2a142a0b92b8" args="" --> 65 <div class="memitem"> 66 <div class="memproto"> 67 <table class="memname"> 68 <tr> 69 <td class="memname">typedef struct <a class="el" href="struct__dmxArg.html">_dmxArg</a>* <a class="el" href="struct__dmxArg.html">dmxArg</a></td> 70 </tr> 71 </table> 72 </div> 73 <div class="memdoc"> 74 75 </div> 76 </div> 77 <hr/><h2>Function Documentation</h2> 78 <a class="anchor" id="a6d41e61a00975e123ed72a269d653d23"></a><!-- doxytag: member="dmxarg.h::dmxArgAdd" ref="a6d41e61a00975e123ed72a269d653d23" args="(dmxArg a, const char *string)" --> 79 <div class="memitem"> 80 <div class="memproto"> 81 <table class="memname"> 82 <tr> 83 <td class="memname">void dmxArgAdd </td> 84 <td>(</td> 85 <td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td> 86 <td class="paramname"><em>a</em>, </td> 87 </tr> 88 <tr> 89 <td class="paramkey"></td> 90 <td></td> 91 <td class="paramtype">const char * </td> 92 <td class="paramname"><em>string</em> </td> 93 </tr> 94 <tr> 95 <td></td> 96 <td>)</td> 97 <td></td><td></td> 98 </tr> 99 </table> 100 </div> 101 <div class="memdoc"> 102 <p>Add the <em>string</em> as the next argument in the <em>dmxArg</em> object. </p> 103 104 <p>References <a class="el" href="struct__dmxArg.html#aca6cdc10b22ae5fa4b790c0758eb70c9">_dmxArg::argc</a>, <a class="el" href="struct__dmxArg.html#aa9baf81a4fabcd2d3f6bbbecd0ebd748">_dmxArg::argm</a>, and <a class="el" href="struct__dmxArg.html#aade18557285f464ec800a9ed1fc6c3f5">_dmxArg::argv</a>.</p> 105 106 <p>Referenced by <a class="el" href="dmxarg_8h.html#a7d872851e86ae8063cd13e85ed203d09">dmxArgParse()</a>.</p> 107 108 </div> 109 </div> 110 <a class="anchor" id="a94e36fd228f49fb0a77c34709cbd3a69"></a><!-- doxytag: member="dmxarg.h::dmxArgC" ref="a94e36fd228f49fb0a77c34709cbd3a69" args="(dmxArg a)" --> 111 <div class="memitem"> 112 <div class="memproto"> 113 <table class="memname"> 114 <tr> 115 <td class="memname">int dmxArgC </td> 116 <td>(</td> 117 <td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td> 118 <td class="paramname"><em>a</em></td><td>)</td> 119 <td></td> 120 </tr> 121 </table> 122 </div> 123 <div class="memdoc"> 124 <p>Return the number of arguments in the <em>dmxArg</em> object. </p> 125 126 <p>References <a class="el" href="struct__dmxArg.html#aca6cdc10b22ae5fa4b790c0758eb70c9">_dmxArg::argc</a>.</p> 127 128 <p>Referenced by <a class="el" href="dmxinputinit_8c.html#a5845f0dbf305a8a233d3747489745faa">dmxInputInit()</a>, and <a class="el" href="dmxinputinit_8c.html#ac4ea57a3ba798705d63254cdbbefb63d">dmxPopulateLocal()</a>.</p> 129 130 </div> 131 </div> 132 <a class="anchor" id="af4ecb9595303a7fcac5eae840766b6fb"></a><!-- doxytag: member="dmxarg.h::dmxArgCreate" ref="af4ecb9595303a7fcac5eae840766b6fb" args="(void)" --> 133 <div class="memitem"> 134 <div class="memproto"> 135 <table class="memname"> 136 <tr> 137 <td class="memname"><a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgCreate </td> 138 <td>(</td> 139 <td class="paramtype">void </td> 140 <td class="paramname"></td><td>)</td> 141 <td></td> 142 </tr> 143 </table> 144 </div> 145 <div class="memdoc"> 146 <p>Create an (externally opaque) <em>dmxArg</em> object. </p> 147 148 <p>References <a class="el" href="struct__dmxArg.html#aca6cdc10b22ae5fa4b790c0758eb70c9">_dmxArg::argc</a>, <a class="el" href="struct__dmxArg.html#aa9baf81a4fabcd2d3f6bbbecd0ebd748">_dmxArg::argm</a>, and <a class="el" href="struct__dmxArg.html#aade18557285f464ec800a9ed1fc6c3f5">_dmxArg::argv</a>.</p> 149 150 <p>Referenced by <a class="el" href="dmxarg_8h.html#a7d872851e86ae8063cd13e85ed203d09">dmxArgParse()</a>.</p> 151 152 </div> 153 </div> 154 <a class="anchor" id="aa6b362f314787cc0e0fd7ca55b53a5cc"></a><!-- doxytag: member="dmxarg.h::dmxArgFree" ref="aa6b362f314787cc0e0fd7ca55b53a5cc" args="(dmxArg a)" --> 155 <div class="memitem"> 156 <div class="memproto"> 157 <table class="memname"> 158 <tr> 159 <td class="memname">void dmxArgFree </td> 160 <td>(</td> 161 <td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td> 162 <td class="paramname"><em>a</em></td><td>)</td> 163 <td></td> 164 </tr> 165 </table> 166 </div> 167 <div class="memdoc"> 168 <p>Free the specified <em>dmxArg</em> object. </p> 169 170 <p>References <a class="el" href="struct__dmxArg.html#aca6cdc10b22ae5fa4b790c0758eb70c9">_dmxArg::argc</a>, and <a class="el" href="struct__dmxArg.html#aade18557285f464ec800a9ed1fc6c3f5">_dmxArg::argv</a>.</p> 171 172 <p>Referenced by <a class="el" href="dmxinputinit_8c.html#a5845f0dbf305a8a233d3747489745faa">dmxInputInit()</a>.</p> 173 174 </div> 175 </div> 176 <a class="anchor" id="a7d872851e86ae8063cd13e85ed203d09"></a><!-- doxytag: member="dmxarg.h::dmxArgParse" ref="a7d872851e86ae8063cd13e85ed203d09" args="(const char *string)" --> 177 <div class="memitem"> 178 <div class="memproto"> 179 <table class="memname"> 180 <tr> 181 <td class="memname"><a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgParse </td> 182 <td>(</td> 183 <td class="paramtype">const char * </td> 184 <td class="paramname"><em>string</em></td><td>)</td> 185 <td></td> 186 </tr> 187 </table> 188 </div> 189 <div class="memdoc"> 190 <p>Parse a string into arguments delimited by commas. Return a new <em>dmxArg</em> object containing the arguments. </p> 191 192 <p>References <a class="el" href="dmxarg_8c.html#a6d41e61a00975e123ed72a269d653d23">dmxArgAdd()</a>, and <a class="el" href="dmxarg_8c.html#af4ecb9595303a7fcac5eae840766b6fb">dmxArgCreate()</a>.</p> 193 194 <p>Referenced by <a class="el" href="dmxinputinit_8c.html#a5845f0dbf305a8a233d3747489745faa">dmxInputInit()</a>.</p> 195 196 </div> 197 </div> 198 <a class="anchor" id="a7de14f607c61ecac05f9c45d002e36ab"></a><!-- doxytag: member="dmxarg.h::dmxArgV" ref="a7de14f607c61ecac05f9c45d002e36ab" args="(dmxArg a, int item)" --> 199 <div class="memitem"> 200 <div class="memproto"> 201 <table class="memname"> 202 <tr> 203 <td class="memname">const char* dmxArgV </td> 204 <td>(</td> 205 <td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td> 206 <td class="paramname"><em>a</em>, </td> 207 </tr> 208 <tr> 209 <td class="paramkey"></td> 210 <td></td> 211 <td class="paramtype">int </td> 212 <td class="paramname"><em>item</em> </td> 213 </tr> 214 <tr> 215 <td></td> 216 <td>)</td> 217 <td></td><td></td> 218 </tr> 219 </table> 220 </div> 221 <div class="memdoc"> 222 <p>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. </p> 223 224 <p>References <a class="el" href="struct__dmxArg.html#aca6cdc10b22ae5fa4b790c0758eb70c9">_dmxArg::argc</a>, and <a class="el" href="struct__dmxArg.html#aade18557285f464ec800a9ed1fc6c3f5">_dmxArg::argv</a>.</p> 225 226 <p>Referenced by <a class="el" href="dmxinputinit_8c.html#a5845f0dbf305a8a233d3747489745faa">dmxInputInit()</a>, and <a class="el" href="dmxinputinit_8c.html#ac4ea57a3ba798705d63254cdbbefb63d">dmxPopulateLocal()</a>.</p> 227 228 </div> 229 </div> 230 </div> 231 </div> 232 <div id="nav-path" class="navpath"> 233 <ul> 234 <li class="navelem"><a class="el" href="dmxarg_8h.html">dmxarg.h</a> </li> 235 <hr> 236 <address> 237 <small> 238 Generated June 29, 2004 for <a 239 href="http://dmx.sourceforge.net">Distributed Multihead X</a> by 240 <a href="http://www.doxygen.org/index.html">doxygen</a> 241 1.3.4. 242 </small> 243 </addres> 244 </hr> 245 </body> 246 </html> 247
Indexes created Mon Oct 26 00:26:21 UTC 2026