<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::CommandOptionRest Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_command_option_rest.html">CommandOptionRest</a></div>
<h1>ost::CommandOptionRest Class Reference</h1><!-- doxytag: class="ost::CommandOptionRest" --><!-- doxytag: inherits="ost::CommandOptionWithArg" -->It only makes sense to have a single one of these set and it is exclusive with <a class="el" href="classost_1_1_command_option.html#989bf900aed6323812ae6922edcdc4af">CommandOptionCollect.CommandOption</a> to take the rest of the command line.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cmdoptns_8h-source.html">cmdoptns.h</a>></code>
<p>
<p>Inheritance diagram for ost::CommandOptionRest:
<p><center><img src="classost_1_1_command_option_rest.png" usemap="#ost::CommandOptionRest_map" border="0" alt=""></center>
<map name="ost::CommandOptionRest_map">
<area href="classost_1_1_command_option_with_arg.html" alt="ost::CommandOptionWithArg" shape="rect" coords="0,56,171,80">
<area href="classost_1_1_command_option.html" alt="ost::CommandOption" shape="rect" coords="0,0,171,24">
</map>
<a href="classost_1_1_command_option_rest-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_rest.html#df9824e9309fd733c2deb4f5652353c9">CommandOptionRest</a> (const char *inOptionName, const char *inOptionLetter, const char *inDescription, bool inRequired=false, <a class="el" href="classost_1_1_command_option.html">CommandOption</a> **ppNext=&<a class="el" href="namespaceost.html#3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classost_1_1_command_option_rest.html">CommandOptionRest</a> contructor. <a href="#df9824e9309fd733c2deb4f5652353c9"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
It only makes sense to have a single one of these set and it is exclusive with <a class="el" href="classost_1_1_command_option.html#989bf900aed6323812ae6922edcdc4af">CommandOptionCollect.CommandOption</a> to take the rest of the command line.
<p>
It is the option that takes the rest of the command line options that are not part of any other options. e.g. "strace -ofile command arg1 arg2". The "command arg1 arg2" part is placed in objects of this class. <dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="cmdlineopt_8cpp-example.html#_a15">cmdlineopt.cpp</a>.</dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="df9824e9309fd733c2deb4f5652353c9"></a><!-- doxytag: member="ost::CommandOptionRest::CommandOptionRest" ref="df9824e9309fd733c2deb4f5652353c9" args="(const char *inOptionName, const char *inOptionLetter, const char *inDescription, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::CommandOptionRest::CommandOptionRest </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>inOptionName</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>inOptionLetter</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>inDescription</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>inRequired</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classost_1_1_command_option.html">CommandOption</a> ** </td>
<td class="mdname" nowrap> <em>ppNext</em> = <code>&<a class="el" href="namespaceost.html#3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a></code></td>
</tr>
<tr>
<td class="md"></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>
<a class="el" href="classost_1_1_command_option_rest.html">CommandOptionRest</a> contructor.
<p>
This sets the optionType for this object to Trailing.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>inOptionName</em> </td><td>long option name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inOptionLetter</em> </td><td>short letter name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inDescription</em> </td><td>short description of the option </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inRequired</em> </td><td>true if option is required </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ppNext</em> </td><td>the linked list header </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cmdoptns_8h-source.html">cmdoptns.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
