diff options
Diffstat (limited to 'hw/dmx/doc/html/dmxarg_8h.html')
| -rw-r--r-- | hw/dmx/doc/html/dmxarg_8h.html | 246 |
1 files changed, 246 insertions, 0 deletions
diff --git a/hw/dmx/doc/html/dmxarg_8h.html b/hw/dmx/doc/html/dmxarg_8h.html new file mode 100644 index 0000000..7c378aa --- /dev/null +++ b/hw/dmx/doc/html/dmxarg_8h.html @@ -0,0 +1,246 @@ +<!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.7.3 --> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.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 id="navrow2" class="tabs2"> + <ul class="tablist"> + <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 id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> + initNavTree('dmxarg_8h.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<h1>dmxarg.h File Reference</h1> </div> +</div> +<div class="contents"> + +<p><a href="dmxarg_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr><td colspan="2"><h2><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<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> +<tr><td colspan="2"><h2><a name="func-members"></a> +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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.html#a7d872851e86ae8063cd13e85ed203d09">dmxArgParse</a> (const char *string)</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<div class="textblock"><p>Interface to argument handling functions. </p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="dmxarg_8c.html">dmxarg.c</a> </dd></dl> +</div><hr/><h2>Typedef Documentation</h2> +<a class="anchor" id="a7f310ec1f9d20311533a2a142a0b92b8"></a><!-- doxytag: member="dmxarg.h::dmxArg" ref="a7f310ec1f9d20311533a2a142a0b92b8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="struct__dmxArg.html">_dmxArg</a>* <a class="el" href="struct__dmxArg.html">dmxArg</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<hr/><h2>Function Documentation</h2> +<a class="anchor" id="a6d41e61a00975e123ed72a269d653d23"></a><!-- doxytag: member="dmxarg.h::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> + </tr> + <tr> + <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="struct__dmxArg.html#adeac746e040cef494abdc25f02c34cd5">_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> + +<p>Referenced by <a class="el" href="dmxarg_8h.html#a7d872851e86ae8063cd13e85ed203d09">dmxArgParse()</a>.</p> + +</div> +</div> +<a class="anchor" id="a94e36fd228f49fb0a77c34709cbd3a69"></a><!-- doxytag: member="dmxarg.h::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="struct__dmxArg.html#adeac746e040cef494abdc25f02c34cd5">_dmxArg::argc</a>.</p> + +<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> + +</div> +</div> +<a class="anchor" id="af4ecb9595303a7fcac5eae840766b6fb"></a><!-- doxytag: member="dmxarg.h::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="struct__dmxArg.html#adeac746e040cef494abdc25f02c34cd5">_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> + +<p>Referenced by <a class="el" href="dmxarg_8h.html#a7d872851e86ae8063cd13e85ed203d09">dmxArgParse()</a>.</p> + +</div> +</div> +<a class="anchor" id="aa6b362f314787cc0e0fd7ca55b53a5cc"></a><!-- doxytag: member="dmxarg.h::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="struct__dmxArg.html#adeac746e040cef494abdc25f02c34cd5">_dmxArg::argc</a>, and <a class="el" href="struct__dmxArg.html#aade18557285f464ec800a9ed1fc6c3f5">_dmxArg::argv</a>.</p> + +<p>Referenced by <a class="el" href="dmxinputinit_8c.html#a5845f0dbf305a8a233d3747489745faa">dmxInputInit()</a>.</p> + +</div> +</div> +<a class="anchor" id="a7d872851e86ae8063cd13e85ed203d09"></a><!-- doxytag: member="dmxarg.h::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.html#a6d41e61a00975e123ed72a269d653d23">dmxArgAdd()</a>, and <a class="el" href="dmxarg_8c.html#af4ecb9595303a7fcac5eae840766b6fb">dmxArgCreate()</a>.</p> + +<p>Referenced by <a class="el" href="dmxinputinit_8c.html#a5845f0dbf305a8a233d3747489745faa">dmxInputInit()</a>.</p> + +</div> +</div> +<a class="anchor" id="a7de14f607c61ecac05f9c45d002e36ab"></a><!-- doxytag: member="dmxarg.h::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> + </tr> + <tr> + <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="struct__dmxArg.html#adeac746e040cef494abdc25f02c34cd5">_dmxArg::argc</a>, and <a class="el" href="struct__dmxArg.html#aade18557285f464ec800a9ed1fc6c3f5">_dmxArg::argv</a>.</p> + +<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> + +</div> +</div> +</div> +</div> + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="dmxarg_8h.html">dmxarg.h</a> </li> + <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> |