| ost::CommandOptionParse(3) | Library Functions Manual | ost::CommandOptionParse(3) |
ost::CommandOptionParse - This is the CommandOptionParse interface class.
#include <cmdoptns.h>
virtual ~CommandOptionParse ()=0
Virtual destructor needed so that the object may be correctly deleted. virtual
bool argsHaveError ()=0
Get the value of the error flag set if the parser encountered errors. virtual
const char * printErrors ()=0
Return a string of text describing the list of errors encountered. virtual
const char * printUsage ()=0
Return a string that contains the usage description of this list of
paramaters. virtual void registerError (const char *errMsg)=0
Register an error with this parser. virtual void performTask ()=0
The method should be invoked by the main code once it has determined that the
application should be started.
This is the CommandOptionParse interface class.
To implement this object you can call makeCommandOptionParse(); This will instantiate a dynamically allocated version of this class and parse the command line for the list of command options that are passed in.
Author
Examples
cmdlineopt.cpp.
Virtual destructor needed so that the object may be correctly deleted.
Get the value of the error flag set if the parser encountered errors.
Examples
cmdlineopt.cpp.
The method should be invoked by the main code once it has determined that the application should be started.
Examples
cmdlineopt.cpp.
Return a string of text describing the list of errors encountered.
Examples
cmdlineopt.cpp.
Return a string that contains the usage description of this list of paramaters.
Examples
cmdlineopt.cpp.
Register an error with this parser. This string will be appended to the errors already buffered in this object.
Examples
cmdlineopt.cpp.
Generated automatically by Doxygen for GNU CommonC++ from the source code.
| Sun Dec 27 2020 | GNU CommonC++ |