<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>File Index</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>dmxarg.c File Reference</h1><code>#include "<a class="el" href="dmx_8h_source.html">dmx.h</a>"</code><br/>
<code>#include "<a class="el" href="dmxarg_8h_source.html">dmxarg.h</a>"</code><br/>
<code>#include <stdio.h></code><br/>
<code>#include <string.h></code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__dmxArg.html">_dmxArg</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8c.html#a6da7af093c10727644c84f2c0de19dae">DMX_ARG_TEST</a> 0</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<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_8c.html#af4ecb9595303a7fcac5eae840766b6fb">dmxArgCreate</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8c.html#aa6b362f314787cc0e0fd7ca55b53a5cc">dmxArgFree</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8c.html#a6d41e61a00975e123ed72a269d653d23">dmxArgAdd</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a, const char *string)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8c.html#a7de14f607c61ecac05f9c45d002e36ab">dmxArgV</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a, int item)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dmxarg_8c.html#a94e36fd228f49fb0a77c34709cbd3a69">dmxArgC</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a)</td></tr>
<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_8c.html#a7d872851e86ae8063cd13e85ed203d09">dmxArgParse</a> (const char *string)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Generic comma-delimited argument processing. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a6da7af093c10727644c84f2c0de19dae"></a><!-- doxytag: member="dmxarg.c::DMX_ARG_TEST" ref="a6da7af093c10727644c84f2c0de19dae" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DMX_ARG_TEST 0</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a6d41e61a00975e123ed72a269d653d23"></a><!-- doxytag: member="dmxarg.c::dmxArgAdd" ref="a6d41e61a00975e123ed72a269d653d23" args="(dmxArg a, const char *string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dmxArgAdd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
<td class="paramname"> <em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>string</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add the <em>string</em> as the next argument in the <em>dmxArg</em> object. </p>
<p>References <a class="el" href="dmxarg_8c_source.html#l00054">_dmxArg::argc</a>, <a class="el" href="dmxarg_8c_source.html#l00055">_dmxArg::argm</a>, and <a class="el" href="dmxarg_8c_source.html#l00056">_dmxArg::argv</a>.</p>
<p>Referenced by <a class="el" href="dmxarg_8c_source.html#l00106">dmxArgParse()</a>.</p>
</div>
</div>
<a class="anchor" id="a94e36fd228f49fb0a77c34709cbd3a69"></a><!-- doxytag: member="dmxarg.c::dmxArgC" ref="a94e36fd228f49fb0a77c34709cbd3a69" args="(dmxArg a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dmxArgC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
<td class="paramname"> <em>a</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of arguments in the <em>dmxArg</em> object. </p>
<p>References <a class="el" href="dmxarg_8c_source.html#l00054">_dmxArg::argc</a>.</p>
<p>Referenced by <a class="el" href="dmxinputinit_8c_source.html#l00962">dmxInputInit()</a>, and <a class="el" href="dmxinputinit_8c_source.html#l00798">dmxPopulateLocal()</a>.</p>
</div>
</div>
<a class="anchor" id="af4ecb9595303a7fcac5eae840766b6fb"></a><!-- doxytag: member="dmxarg.c::dmxArgCreate" ref="af4ecb9595303a7fcac5eae840766b6fb" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgCreate </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an (externally opaque) <em>dmxArg</em> object. </p>
<p>References <a class="el" href="dmxarg_8c_source.html#l00054">_dmxArg::argc</a>, <a class="el" href="dmxarg_8c_source.html#l00055">_dmxArg::argm</a>, and <a class="el" href="dmxarg_8c_source.html#l00056">_dmxArg::argv</a>.</p>
<p>Referenced by <a class="el" href="dmxarg_8c_source.html#l00106">dmxArgParse()</a>.</p>
</div>
</div>
<a class="anchor" id="aa6b362f314787cc0e0fd7ca55b53a5cc"></a><!-- doxytag: member="dmxarg.c::dmxArgFree" ref="aa6b362f314787cc0e0fd7ca55b53a5cc" args="(dmxArg a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dmxArgFree </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
<td class="paramname"> <em>a</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free the specified <em>dmxArg</em> object. </p>
<p>References <a class="el" href="dmxarg_8c_source.html#l00054">_dmxArg::argc</a>, and <a class="el" href="dmxarg_8c_source.html#l00056">_dmxArg::argv</a>.</p>
<p>Referenced by <a class="el" href="dmxinputinit_8c_source.html#l00962">dmxInputInit()</a>.</p>
</div>
</div>
<a class="anchor" id="a7d872851e86ae8063cd13e85ed203d09"></a><!-- doxytag: member="dmxarg.c::dmxArgParse" ref="a7d872851e86ae8063cd13e85ed203d09" args="(const char *string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgParse </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>string</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse a string into arguments delimited by commas. Return a new <em>dmxArg</em> object containing the arguments. </p>
<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>
<p>Referenced by <a class="el" href="dmxinputinit_8c_source.html#l00962">dmxInputInit()</a>.</p>
</div>
</div>
<a class="anchor" id="a7de14f607c61ecac05f9c45d002e36ab"></a><!-- doxytag: member="dmxarg.c::dmxArgV" ref="a7de14f607c61ecac05f9c45d002e36ab" args="(dmxArg a, int item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* dmxArgV </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
<td class="paramname"> <em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>item</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<p>References <a class="el" href="dmxarg_8c_source.html#l00054">_dmxArg::argc</a>, and <a class="el" href="dmxarg_8c_source.html#l00056">_dmxArg::argv</a>.</p>
<p>Referenced by <a class="el" href="dmxinputinit_8c_source.html#l00962">dmxInputInit()</a>, and <a class="el" href="dmxinputinit_8c_source.html#l00798">dmxPopulateLocal()</a>.</p>
</div>
</div>
</div>
<hr>
<address>
<small>
Generated June 29, 2004 for <a
href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
<a href="http://www.doxygen.org/index.html">doxygen</a>
1.3.4.
</small>
</addres>
</hr>
</body>
</html>