First import
[xorg_rtime.git] / xorg-server-1.4 / hw / dmx / doc / html / dmxarg_8c.html
blobdb05599a61aa8fe2da61c97b7717390bc68ba45f
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.c File Reference</h1><code>#include "<a class="el" href="dmx_8h-source.html">dmx.h</a>"</code><br>
12 <code>#include "<a class="el" href="dmxarg_8h-source.html">dmxarg.h</a>"</code><br>
13 <code>#include &lt;stdio.h&gt;</code><br>
14 <code>#include &lt;string.h&gt;</code><br>
15 <table border=0 cellpadding=0 cellspacing=0>
16 <tr><td></td></tr>
17 <tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
18 <tr><td class="memItemLeft" nowrap align=right valign=top>struct &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="struct__dmxArg.html">_dmxArg</a></td></tr>
20 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
21 <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_8c.html#a1">dmxArgCreate</a> (void)</td></tr>
23 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8c.html#a2">dmxArgFree</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a)</td></tr>
25 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8c.html#a3">dmxArgAdd</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a, const char *string)</td></tr>
27 <tr><td class="memItemLeft" nowrap align=right valign=top>const char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8c.html#a4">dmxArgV</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a, int item)</td></tr>
29 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8c.html#a5">dmxArgC</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a)</td></tr>
31 <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_8c.html#a6">dmxArgParse</a> (const char *string)</td></tr>
33 </table>
34 <hr><a name="_details"></a><h2>Detailed Description</h2>
35 Generic comma-delimited argument processing.<hr><h2>Function Documentation</h2>
36 <a class="anchor" name="a3" doxytag="dmxarg.c::dmxArgAdd" ></a><p>
37 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
38 <tr>
39 <td class="mdRow">
40 <table cellpadding="0" cellspacing="0" border="0">
41 <tr>
42 <td class="md" nowrap valign="top"> void dmxArgAdd </td>
43 <td class="md" valign="top">(&nbsp;</td>
44 <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a>&nbsp;</td>
45 <td class="mdname" nowrap> <em>a</em>, </td>
46 </tr>
47 <tr>
48 <td></td>
49 <td></td>
50 <td class="md" nowrap>const char *&nbsp;</td>
51 <td class="mdname" nowrap> <em>string</em></td>
52 </tr>
53 <tr>
54 <td></td>
55 <td class="md">)&nbsp;</td>
56 <td class="md" colspan="2"></td>
57 </tr>
59 </table>
60 </td>
61 </tr>
62 </table>
63 <table cellspacing=5 cellpadding=0 border=0>
64 <tr>
65 <td>
66 &nbsp;
67 </td>
68 <td>
70 <p>
71 Add the <em>string</em> as the next argument in the <em>dmxArg</em> object. </td>
72 </tr>
73 </table>
74 <a class="anchor" name="a5" doxytag="dmxarg.c::dmxArgC" ></a><p>
75 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
76 <tr>
77 <td class="mdRow">
78 <table cellpadding="0" cellspacing="0" border="0">
79 <tr>
80 <td class="md" nowrap valign="top"> int dmxArgC </td>
81 <td class="md" valign="top">(&nbsp;</td>
82 <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a>&nbsp;</td>
83 <td class="mdname1" valign="top" nowrap> <em>a</em> </td>
84 <td class="md" valign="top">&nbsp;)&nbsp;</td>
85 <td class="md" nowrap></td>
86 </tr>
88 </table>
89 </td>
90 </tr>
91 </table>
92 <table cellspacing=5 cellpadding=0 border=0>
93 <tr>
94 <td>
95 &nbsp;
96 </td>
97 <td>
99 <p>
100 Return the number of arguments in the <em>dmxArg</em> object. </td>
101 </tr>
102 </table>
103 <a class="anchor" name="a1" doxytag="dmxarg.c::dmxArgCreate" ></a><p>
104 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
105 <tr>
106 <td class="mdRow">
107 <table cellpadding="0" cellspacing="0" border="0">
108 <tr>
109 <td class="md" nowrap valign="top"> <a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgCreate </td>
110 <td class="md" valign="top">(&nbsp;</td>
111 <td class="md" nowrap valign="top">void&nbsp;</td>
112 <td class="mdname1" valign="top" nowrap> </td>
113 <td class="md" valign="top">&nbsp;)&nbsp;</td>
114 <td class="md" nowrap></td>
115 </tr>
117 </table>
118 </td>
119 </tr>
120 </table>
121 <table cellspacing=5 cellpadding=0 border=0>
122 <tr>
123 <td>
124 &nbsp;
125 </td>
126 <td>
129 Create an (externally opaque) <em>dmxArg</em> object. </td>
130 </tr>
131 </table>
132 <a class="anchor" name="a2" doxytag="dmxarg.c::dmxArgFree" ></a><p>
133 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
134 <tr>
135 <td class="mdRow">
136 <table cellpadding="0" cellspacing="0" border="0">
137 <tr>
138 <td class="md" nowrap valign="top"> void dmxArgFree </td>
139 <td class="md" valign="top">(&nbsp;</td>
140 <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a>&nbsp;</td>
141 <td class="mdname1" valign="top" nowrap> <em>a</em> </td>
142 <td class="md" valign="top">&nbsp;)&nbsp;</td>
143 <td class="md" nowrap></td>
144 </tr>
146 </table>
147 </td>
148 </tr>
149 </table>
150 <table cellspacing=5 cellpadding=0 border=0>
151 <tr>
152 <td>
153 &nbsp;
154 </td>
155 <td>
158 Free the specified <em>dmxArg</em> object. </td>
159 </tr>
160 </table>
161 <a class="anchor" name="a6" doxytag="dmxarg.c::dmxArgParse" ></a><p>
162 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
163 <tr>
164 <td class="mdRow">
165 <table cellpadding="0" cellspacing="0" border="0">
166 <tr>
167 <td class="md" nowrap valign="top"> <a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgParse </td>
168 <td class="md" valign="top">(&nbsp;</td>
169 <td class="md" nowrap valign="top">const char *&nbsp;</td>
170 <td class="mdname1" valign="top" nowrap> <em>string</em> </td>
171 <td class="md" valign="top">&nbsp;)&nbsp;</td>
172 <td class="md" nowrap></td>
173 </tr>
175 </table>
176 </td>
177 </tr>
178 </table>
179 <table cellspacing=5 cellpadding=0 border=0>
180 <tr>
181 <td>
182 &nbsp;
183 </td>
184 <td>
187 Parse a string into arguments delimited by commas. Return a new <em>dmxArg</em> object containing the arguments. </td>
188 </tr>
189 </table>
190 <a class="anchor" name="a4" doxytag="dmxarg.c::dmxArgV" ></a><p>
191 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
192 <tr>
193 <td class="mdRow">
194 <table cellpadding="0" cellspacing="0" border="0">
195 <tr>
196 <td class="md" nowrap valign="top"> const char* dmxArgV </td>
197 <td class="md" valign="top">(&nbsp;</td>
198 <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a>&nbsp;</td>
199 <td class="mdname" nowrap> <em>a</em>, </td>
200 </tr>
201 <tr>
202 <td></td>
203 <td></td>
204 <td class="md" nowrap>int&nbsp;</td>
205 <td class="mdname" nowrap> <em>item</em></td>
206 </tr>
207 <tr>
208 <td></td>
209 <td class="md">)&nbsp;</td>
210 <td class="md" colspan="2"></td>
211 </tr>
213 </table>
214 </td>
215 </tr>
216 </table>
217 <table cellspacing=5 cellpadding=0 border=0>
218 <tr>
219 <td>
220 &nbsp;
221 </td>
222 <td>
225 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>
226 </tr>
227 </table>
228 <hr>
229 <address>
230 <small>
231 Generated June 29, 2004 for <a
232 href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
233 <a href="http://www.doxygen.org/index.html">doxygen</a>
234 1.3.4.
235 </small>
236 </addres>
237 </hr>
238 </body>
239 </html>