<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>cmdoptns.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.5 on Thu Oct 4 15:32:58 2001 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>cmdoptns.h File Reference</h1>
<p>
<a href="cmdoptns_h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_commandoption.html">CommandOption</a></td></tr>
<tr><td> </td><td><font size=-1><em>CommandOption is the base class for all command line options.</em> <a href="class_commandoption.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_commandoptionarg.html">CommandOptionArg</a></td></tr>
<tr><td> </td><td><font size=-1><em>Class for options with an argument e.g.</em> <a href="class_commandoptionarg.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_commandoptioncollect.html">CommandOptionCollect</a></td></tr>
<tr><td> </td><td><font size=-1><em>It only makes sense to have a single one of these set and it is also exclusive with <a class="el" href="class_commandoptionrest.html">CommandOptionRest</a>. <a class="el" href="class_commandoption.html">CommandOption</a> to collect parameters that are not options.</em> <a href="class_commandoptioncollect.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_commandoptionnoarg.html">CommandOptionNoArg</a></td></tr>
<tr><td> </td><td><font size=-1><em><a class="el" href="class_commandoption.html">CommandOption</a> type for flags.</em> <a href="class_commandoptionnoarg.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_commandoptionparse.html">CommandOptionParse</a></td></tr>
<tr><td> </td><td><font size=-1><em>This is the CommandOptionParse interface class.</em> <a href="class_commandoptionparse.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_commandoptionrest.html">CommandOptionRest</a></td></tr>
<tr><td> </td><td><font size=-1><em>It only makes sense to have a single one of these set and it is exclusive with <a class="el" href="class_commandoptioncollect.html">CommandOptionCollect</a>. <a class="el" href="class_commandoption.html">CommandOption</a> to take the rest of the command line.</em> <a href="class_commandoptionrest.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_commandoptionwitharg.html">CommandOptionWithArg</a></td></tr>
<tr><td> </td><td><font size=-1><em>Derived class of <a class="el" href="class_commandoption.html">CommandOption</a> for options that have a value associated with them.</em> <a href="class_commandoptionwitharg.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_commandoptionparse.html">CommandOptionParse</a>* </td><td valign=bottom><a class="el" href="cmdoptns_h.html#a1">MakeCommandOptionParse</a> (int argc, char **argv, char *comment, <a class="el" href="class_commandoption.html">CommandOption</a> *options=<a class="el" href="cmdoptns_h.html#a0">DefaultCommandOptionList</a>)</td></tr>
<tr><td> </td><td><font size=-1><em>MakeCommandOptionParse will create an implementation of a <a class="el" href="class_commandoptionparse.html">CommandOptionParse</a> object.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_commandoption.html">CommandOption</a>* </td><td valign=bottom><a class="el" href="cmdoptns_h.html#a0">DefaultCommandOptionList</a></td></tr>
<tr><td> </td><td><font size=-1><em>This defines a linked list head pointer for all the command line options that use the default list.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a1" doxytag="cmdoptns.h::MakeCommandOptionParse"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="class_commandoptionparse.html">CommandOptionParse</a> * MakeCommandOptionParse (
</b></td>
<td valign="bottom"><b>
int <em>argc</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
char ** <em>argv</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
char * <em>comment</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="class_commandoption.html">CommandOption</a> * <em>options</em> = <a class="el" href="cmdoptns_h.html#a0">DefaultCommandOptionList</a> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
MakeCommandOptionParse will create an implementation of a <a class="el" href="class_commandoptionparse.html">CommandOptionParse</a> object.
<p>
This particular implementation is a wrapper around getopt_long(3). That interface unfortunatly does not provide enough information to give the best error messages with malformed input. If the implementation changes there is a good chance that the binary interface will remain the same. </td>
</tr>
</table>
<hr><h2>Variable Documentation</h2>
<a name="a0" doxytag="cmdoptns.h::DefaultCommandOptionList"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="class_commandoption.html">CommandOption</a> * DefaultCommandOptionList
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
This defines a linked list head pointer for all the command line options that use the default list.
<p>
It will most likely be used in most cases without being explicitly referenced in application code. It is a default value of various method's parameters. </td>
</tr>
</table>
<hr><address><small>Generated at Thu Oct 4 15:32:58 2001 for CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
68d373e54fb21da3730c08bede406633
>
files
>
746
