1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
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">
9
<!-- Generated by Doxygen 1.6.3 -->
10
<div class="navigation" id="top">
13
<li><a href="main.html"><span>Main Page</span></a></li>
14
<li><a href="annotated.html"><span>Data Structures</span></a></li>
15
<li class="current"><a href="files.html"><span>Files</span></a></li>
20
<li><a href="files.html"><span>File List</span></a></li>
21
<li><a href="globals.html"><span>Globals</span></a></li>
25
<div class="contents">
26
<h1>dmxarg.h File Reference</h1>
27
<p><a href="dmxarg_8h_source.html">Go to the source code of this file.</a></p>
28
<table border="0" cellpadding="0" cellspacing="0">
29
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
30
<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>
31
<tr><td colspan="2"><h2>Functions</h2></td></tr>
32
<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>
33
<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>
34
<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>
35
<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>
36
<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>
37
<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>
39
<hr/><a name="_details"></a><h2>Detailed Description</h2>
40
<p>Interface to argument handling functions. </p>
41
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="dmxarg_8c.html">dmxarg.c</a> </dd></dl>
42
<hr/><h2>Typedef Documentation</h2>
43
<a class="anchor" id="a7f310ec1f9d20311533a2a142a0b92b8"></a><!-- doxytag: member="dmxarg.h::dmxArg" ref="a7f310ec1f9d20311533a2a142a0b92b8" args="" -->
45
<div class="memproto">
46
<table class="memname">
48
<td class="memname">typedef struct <a class="el" href="struct__dmxArg.html">_dmxArg</a>* <a class="el" href="struct__dmxArg.html">dmxArg</a></td>
56
<hr/><h2>Function Documentation</h2>
57
<a class="anchor" id="a6d41e61a00975e123ed72a269d653d23"></a><!-- doxytag: member="dmxarg.h::dmxArgAdd" ref="a6d41e61a00975e123ed72a269d653d23" args="(dmxArg a, const char *string)" -->
59
<div class="memproto">
60
<table class="memname">
62
<td class="memname">void dmxArgAdd </td>
64
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
65
<td class="paramname"> <em>a</em>, </td>
68
<td class="paramkey"></td>
70
<td class="paramtype">const char * </td>
71
<td class="paramname"> <em>string</em></td><td> </td>
76
<td></td><td></td><td></td>
81
<p>Add the <em>string</em> as the next argument in the <em>dmxArg</em> object. </p>
83
<p>References <a class="el" href="dmxarg_8c_source.html#l00046">_dmxArg::argc</a>, <a class="el" href="dmxarg_8c_source.html#l00047">_dmxArg::argm</a>, and <a class="el" href="dmxarg_8c_source.html#l00048">_dmxArg::argv</a>.</p>
85
<p>Referenced by <a class="el" href="dmxarg_8c_source.html#l00106">dmxArgParse()</a>.</p>
89
<a class="anchor" id="a94e36fd228f49fb0a77c34709cbd3a69"></a><!-- doxytag: member="dmxarg.h::dmxArgC" ref="a94e36fd228f49fb0a77c34709cbd3a69" args="(dmxArg a)" -->
91
<div class="memproto">
92
<table class="memname">
94
<td class="memname">int dmxArgC </td>
96
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
97
<td class="paramname"> <em>a</em></td>
98
<td> ) </td>
104
<p>Return the number of arguments in the <em>dmxArg</em> object. </p>
106
<p>References <a class="el" href="dmxarg_8c_source.html#l00046">_dmxArg::argc</a>.</p>
108
<p>Referenced by <a class="el" href="dmxinputinit_8c_source.html#l00961">dmxInputInit()</a>, and <a class="el" href="dmxinputinit_8c_source.html#l00798">dmxPopulateLocal()</a>.</p>
112
<a class="anchor" id="af4ecb9595303a7fcac5eae840766b6fb"></a><!-- doxytag: member="dmxarg.h::dmxArgCreate" ref="af4ecb9595303a7fcac5eae840766b6fb" args="(void)" -->
113
<div class="memitem">
114
<div class="memproto">
115
<table class="memname">
117
<td class="memname"><a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgCreate </td>
119
<td class="paramtype">void </td>
120
<td class="paramname"></td>
121
<td> ) </td>
127
<p>Create an (externally opaque) <em>dmxArg</em> object. </p>
129
<p>References <a class="el" href="dmxarg_8c_source.html#l00046">_dmxArg::argc</a>, <a class="el" href="dmxarg_8c_source.html#l00047">_dmxArg::argm</a>, and <a class="el" href="dmxarg_8c_source.html#l00048">_dmxArg::argv</a>.</p>
131
<p>Referenced by <a class="el" href="dmxarg_8c_source.html#l00106">dmxArgParse()</a>.</p>
135
<a class="anchor" id="aa6b362f314787cc0e0fd7ca55b53a5cc"></a><!-- doxytag: member="dmxarg.h::dmxArgFree" ref="aa6b362f314787cc0e0fd7ca55b53a5cc" args="(dmxArg a)" -->
136
<div class="memitem">
137
<div class="memproto">
138
<table class="memname">
140
<td class="memname">void dmxArgFree </td>
142
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
143
<td class="paramname"> <em>a</em></td>
144
<td> ) </td>
150
<p>Free the specified <em>dmxArg</em> object. </p>
152
<p>References <a class="el" href="dmxarg_8c_source.html#l00046">_dmxArg::argc</a>, and <a class="el" href="dmxarg_8c_source.html#l00048">_dmxArg::argv</a>.</p>
154
<p>Referenced by <a class="el" href="dmxinputinit_8c_source.html#l00961">dmxInputInit()</a>.</p>
158
<a class="anchor" id="a7d872851e86ae8063cd13e85ed203d09"></a><!-- doxytag: member="dmxarg.h::dmxArgParse" ref="a7d872851e86ae8063cd13e85ed203d09" args="(const char *string)" -->
159
<div class="memitem">
160
<div class="memproto">
161
<table class="memname">
163
<td class="memname"><a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgParse </td>
165
<td class="paramtype">const char * </td>
166
<td class="paramname"> <em>string</em></td>
167
<td> ) </td>
173
<p>Parse a string into arguments delimited by commas. Return a new <em>dmxArg</em> object containing the arguments. </p>
175
<p>References <a class="el" href="dmxarg_8c_source.html#l00081">dmxArgAdd()</a>, and <a class="el" href="dmxarg_8c_source.html#l00060">dmxArgCreate()</a>.</p>
177
<p>Referenced by <a class="el" href="dmxinputinit_8c_source.html#l00961">dmxInputInit()</a>.</p>
181
<a class="anchor" id="a7de14f607c61ecac05f9c45d002e36ab"></a><!-- doxytag: member="dmxarg.h::dmxArgV" ref="a7de14f607c61ecac05f9c45d002e36ab" args="(dmxArg a, int item)" -->
182
<div class="memitem">
183
<div class="memproto">
184
<table class="memname">
186
<td class="memname">const char* dmxArgV </td>
188
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
189
<td class="paramname"> <em>a</em>, </td>
192
<td class="paramkey"></td>
194
<td class="paramtype">int </td>
195
<td class="paramname"> <em>item</em></td><td> </td>
200
<td></td><td></td><td></td>
205
<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>
207
<p>References <a class="el" href="dmxarg_8c_source.html#l00046">_dmxArg::argc</a>, and <a class="el" href="dmxarg_8c_source.html#l00048">_dmxArg::argv</a>.</p>
209
<p>Referenced by <a class="el" href="dmxinputinit_8c_source.html#l00961">dmxInputInit()</a>, and <a class="el" href="dmxinputinit_8c_source.html#l00798">dmxPopulateLocal()</a>.</p>
217
Generated June 29, 2004 for <a
218
href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
219
<a href="http://www.doxygen.org/index.html">doxygen</a>