236 lines
		
	
	
		
			8.5 KiB
		
	
	
	
		
			HTML
		
	
	
	
			
		
		
	
	
			236 lines
		
	
	
		
			8.5 KiB
		
	
	
	
		
			HTML
		
	
	
	
| <!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.3.4 -->
 | |
| <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
 | |
| <h1>dmxarg.h File Reference</h1>
 | |
| <p>
 | |
| <a href="dmxarg_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
 | |
| <tr><td></td></tr>
 | |
| <tr><td colspan=2><br><h2>Functions</h2></td></tr>
 | |
| <tr><td class="memItemLeft" nowrap 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#a1">dmxArgCreate</a> (void)</td></tr>
 | |
| 
 | |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8h.html#a2">dmxArgFree</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a)</td></tr>
 | |
| 
 | |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8h.html#a3">dmxArgAdd</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a, const  char *string)</td></tr>
 | |
| 
 | |
| <tr><td class="memItemLeft" nowrap align=right valign=top>const  char * </td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8h.html#a4">dmxArgV</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a, int item)</td></tr>
 | |
| 
 | |
| <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="dmxarg_8h.html#a5">dmxArgC</a> (<a class="el" href="struct__dmxArg.html">dmxArg</a> a)</td></tr>
 | |
| 
 | |
| <tr><td class="memItemLeft" nowrap 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#a6">dmxArgParse</a> (const  char *string)</td></tr>
 | |
| 
 | |
| </table>
 | |
| <hr><a name="_details"></a><h2>Detailed Description</h2>
 | |
| Interface to argument handling functions. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxarg_8c.html">dmxarg.c</a></dd></dl>
 | |
| <hr><h2>Function Documentation</h2>
 | |
| <a class="anchor" name="a3" doxytag="dmxarg.h::dmxArgAdd" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> void dmxArgAdd </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
 | |
|           <td class="mdname" nowrap> <em>a</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td></td>
 | |
|           <td class="md" nowrap>const char * </td>
 | |
|           <td class="mdname" nowrap> <em>string</em></td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td class="md">) </td>
 | |
|           <td class="md" colspan="2"></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <p>
 | |
| Add the <em>string</em> as the next argument in the <em>dmxArg</em> object.     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <a class="anchor" name="a5" doxytag="dmxarg.h::dmxArgC" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> int dmxArgC </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
 | |
|           <td class="mdname1" valign="top" nowrap> <em>a</em>          </td>
 | |
|           <td class="md" valign="top"> ) </td>
 | |
|           <td class="md" nowrap></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <p>
 | |
| Return the number of arguments in the <em>dmxArg</em> object.     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <a class="anchor" name="a1" doxytag="dmxarg.h::dmxArgCreate" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> <a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgCreate </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top">void </td>
 | |
|           <td class="mdname1" valign="top" nowrap>          </td>
 | |
|           <td class="md" valign="top"> ) </td>
 | |
|           <td class="md" nowrap></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <p>
 | |
| Create an (externally opaque) <em>dmxArg</em> object.     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <a class="anchor" name="a2" doxytag="dmxarg.h::dmxArgFree" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> void dmxArgFree </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
 | |
|           <td class="mdname1" valign="top" nowrap> <em>a</em>          </td>
 | |
|           <td class="md" valign="top"> ) </td>
 | |
|           <td class="md" nowrap></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <p>
 | |
| Free the specified <em>dmxArg</em> object.     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <a class="anchor" name="a6" doxytag="dmxarg.h::dmxArgParse" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> <a class="el" href="struct__dmxArg.html">dmxArg</a> dmxArgParse </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top">const char * </td>
 | |
|           <td class="mdname1" valign="top" nowrap> <em>string</em>          </td>
 | |
|           <td class="md" valign="top"> ) </td>
 | |
|           <td class="md" nowrap></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <p>
 | |
| Parse a string into arguments delimited by commas. Return a new <em>dmxArg</em> object containing the arguments.     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <a class="anchor" name="a4" doxytag="dmxarg.h::dmxArgV" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> const char* dmxArgV </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top"><a class="el" href="struct__dmxArg.html">dmxArg</a> </td>
 | |
|           <td class="mdname" nowrap> <em>a</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td></td>
 | |
|           <td class="md" nowrap>int </td>
 | |
|           <td class="mdname" nowrap> <em>item</em></td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td class="md">) </td>
 | |
|           <td class="md" colspan="2"></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <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.     </td>
 | |
|   </tr>
 | |
| </table>
 | |
|     <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>
 |