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.7.1 -->
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>
27
<a href="#typedef-members">Typedefs</a> |
28
<a href="#func-members">Functions</a> </div>
29
<div class="headertitle">
30
<h1>dmxarg.h File Reference</h1> </div>
32
<div class="contents">
34
<p><a href="dmxarg_8h_source.html">Go to the source code of this file.</a></p>
35
<table class="memberdecls">
36
<tr><td colspan="2"><h2><a name="typedef-members"></a>
37
Typedefs</h2></td></tr>
38
<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>
39
<tr><td colspan="2"><h2><a name="func-members"></a>
40
Functions</h2></td></tr>
41
<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>
42
<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>
43
<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>
44
<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>
45
<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>
46
<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>
48
<hr/><a name="_details"></a><h2>Detailed Description</h2>
49
<p>Interface to argument handling functions. </p>
50
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="dmxarg_8c.html">dmxarg.c</a> </dd></dl>
51
<hr/><h2>Typedef Documentation</h2>
52
<a class="anchor" id="a7f310ec1f9d20311533a2a142a0b92b8"></a><!-- doxytag: member="dmxarg.h::dmxArg" ref="a7f310ec1f9d20311533a2a142a0b92b8" args="" -->
54
<div class="memproto">
55
<table class="memname">
57
<td class="memname">typedef struct <a class="el" href="struct__dmxArg.html">_dmxArg</a>* <a class="el" href="struct__dmxArg.html">dmxArg</a></td>
65
<hr/><h2>Function Documentation</h2>
66
<a class="anchor" id="a6d41e61a00975e123ed72a269d653d23"></a><!-- doxytag: member="dmxarg.h::dmxArgAdd" ref="a6d41e61a00975e123ed72a269d653d23" args="(dmxArg a, const char *string)" -->
68
<div class="memproto">
69
<table class="memname">
71
<td class="memname">void dmxArgAdd </td>
73
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
74
<td class="paramname"> <em>a</em>, </td>
77
<td class="paramkey"></td>
79
<td class="paramtype">const char * </td>
80
<td class="paramname"> <em>string</em></td><td> </td>
85
<td></td><td></td><td></td>
90
<p>Add the <em>string</em> as the next argument in the <em>dmxArg</em> object. </p>
92
<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>
94
<p>Referenced by <a class="el" href="dmxarg_8h.html#a7d872851e86ae8063cd13e85ed203d09">dmxArgParse()</a>.</p>
98
<a class="anchor" id="a94e36fd228f49fb0a77c34709cbd3a69"></a><!-- doxytag: member="dmxarg.h::dmxArgC" ref="a94e36fd228f49fb0a77c34709cbd3a69" args="(dmxArg a)" -->
100
<div class="memproto">
101
<table class="memname">
103
<td class="memname">int dmxArgC </td>
105
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
106
<td class="paramname"> <em>a</em></td>
107
<td> ) </td>
113
<p>Return the number of arguments in the <em>dmxArg</em> object. </p>
115
<p>References <a class="el" href="struct__dmxArg.html#aca6cdc10b22ae5fa4b790c0758eb70c9">_dmxArg::argc</a>.</p>
117
<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>
121
<a class="anchor" id="af4ecb9595303a7fcac5eae840766b6fb"></a><!-- doxytag: member="dmxarg.h::dmxArgCreate" ref="af4ecb9595303a7fcac5eae840766b6fb" args="(void)" -->
122
<div class="memitem">
123
<div class="memproto">
124
<table class="memname">
126
<td class="memname"><a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgCreate </td>
128
<td class="paramtype">void </td>
129
<td class="paramname"></td>
130
<td> ) </td>
136
<p>Create an (externally opaque) <em>dmxArg</em> object. </p>
138
<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>
140
<p>Referenced by <a class="el" href="dmxarg_8h.html#a7d872851e86ae8063cd13e85ed203d09">dmxArgParse()</a>.</p>
144
<a class="anchor" id="aa6b362f314787cc0e0fd7ca55b53a5cc"></a><!-- doxytag: member="dmxarg.h::dmxArgFree" ref="aa6b362f314787cc0e0fd7ca55b53a5cc" args="(dmxArg a)" -->
145
<div class="memitem">
146
<div class="memproto">
147
<table class="memname">
149
<td class="memname">void dmxArgFree </td>
151
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
152
<td class="paramname"> <em>a</em></td>
153
<td> ) </td>
159
<p>Free the specified <em>dmxArg</em> object. </p>
161
<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>
163
<p>Referenced by <a class="el" href="dmxinputinit_8c.html#a5845f0dbf305a8a233d3747489745faa">dmxInputInit()</a>.</p>
167
<a class="anchor" id="a7d872851e86ae8063cd13e85ed203d09"></a><!-- doxytag: member="dmxarg.h::dmxArgParse" ref="a7d872851e86ae8063cd13e85ed203d09" args="(const char *string)" -->
168
<div class="memitem">
169
<div class="memproto">
170
<table class="memname">
172
<td class="memname"><a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgParse </td>
174
<td class="paramtype">const char * </td>
175
<td class="paramname"> <em>string</em></td>
176
<td> ) </td>
182
<p>Parse a string into arguments delimited by commas. Return a new <em>dmxArg</em> object containing the arguments. </p>
184
<p>References <a class="el" href="dmxarg_8c.html#a6d41e61a00975e123ed72a269d653d23">dmxArgAdd()</a>, and <a class="el" href="dmxarg_8c.html#af4ecb9595303a7fcac5eae840766b6fb">dmxArgCreate()</a>.</p>
186
<p>Referenced by <a class="el" href="dmxinputinit_8c.html#a5845f0dbf305a8a233d3747489745faa">dmxInputInit()</a>.</p>
190
<a class="anchor" id="a7de14f607c61ecac05f9c45d002e36ab"></a><!-- doxytag: member="dmxarg.h::dmxArgV" ref="a7de14f607c61ecac05f9c45d002e36ab" args="(dmxArg a, int item)" -->
191
<div class="memitem">
192
<div class="memproto">
193
<table class="memname">
195
<td class="memname">const char* dmxArgV </td>
197
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
198
<td class="paramname"> <em>a</em>, </td>
201
<td class="paramkey"></td>
203
<td class="paramtype">int </td>
204
<td class="paramname"> <em>item</em></td><td> </td>
209
<td></td><td></td><td></td>
214
<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>
216
<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>
218
<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>
226
Generated June 29, 2004 for <a
227
href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
228
<a href="http://www.doxygen.org/index.html">doxygen</a>