---
name: "CommandOptionParse"
section: "3cc"
platform: "linux"
package: "libcommoncpp2-dev"
version: "1.0.13-5"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://new.carta.tech/CommandOptionParse"
---

# CommandOptionParse(3cc)

This is the CommandOptionParse interface class.

## NAME

CommandOptionParse - This is the CommandOptionParse interface class.

## SYNOPSIS

`#include <cmdoptns.h>`

### Public Methods

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.*

## DETAILED DESCRIPTION

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:**  Gianni Mariani \<gianni@mariani.ws\>

## CONSTRUCTOR & DESTRUCTOR DOCUMENTATION

### virtual CommandOptionParse::~CommandOptionParse ()` [pure virtual]`

Virtual destructor needed so that the object may be correctly deleted.

## MEMBER FUNCTION DOCUMENTATION

### virtual bool CommandOptionParse::argsHaveError ()` [pure virtual]`

Get the value of the error flag set if the parser encountered errors.

### virtual void CommandOptionParse::performTask ()` [pure virtual]`

The method should be invoked by the main code once it has determined that the application should be started.

### virtual const char\* CommandOptionParse::printErrors ()` [pure virtual]`

Return a string of text describing the list of errors encountered.

### virtual const char\* CommandOptionParse::printUsage ()` [pure virtual]`

Return a string that contains the usage description of this list of paramaters.

### virtual void CommandOptionParse::registerError (const char \* errMsg)` [pure virtual]`

Register an error with this parser.

This string will be appended to the errors already buffered in this object.

## AUTHOR

Generated automatically by Doxygen for CommonC++ from the source code.