---
name: "ost_CommandOptionCollect"
section: "3"
platform: "linux"
package: "libcommoncpp2-doc"
version: "1.8.1-10"
release: "Debian 11 (Bullseye)"
platforms: ["linux"]
url: "https://new.carta.tech/ost_CommandOptionCollect"
---

# ost\_CommandOptionCollect(3)

It only makes sense to have a single one of these set and it is also exclusive with CommandOptionRest.

## NAME

ost::CommandOptionCollect - It only makes sense to have a single one of these set and it is also exclusive with **CommandOptionRest**.

## SYNOPSIS

`#include <cmdoptns.h>`

Inherits **ost::CommandOptionWithArg**.

### Public Member Functions

**CommandOptionCollect** (const char \*inOptionName, const char \*inOptionLetter, const char \*inDescription, bool inRequired=false, **CommandOption** \*\*ppNext=&**defaultCommandOptionList**)\
 **CommandOptionRest** contructor.

### Additional Inherited Members

## Detailed Description

It only makes sense to have a single one of these set and it is also exclusive with **CommandOptionRest**.

This makes parameter collecting behave line the Unix 'cat' command.

**CommandOption** to collect parameters that are not options.

**Examples** **cmdlineopt.cpp**.

## Constructor & Destructor Documentation

### ost::CommandOptionCollect::CommandOptionCollect (const char \* inOptionName, const char \* inOptionLetter, const char \* inDescription, bool inRequired = `false`, CommandOption \*\* ppNext = `&`defaultCommandOptionList)

**CommandOptionRest** contructor. This sets the optionType for this object to Collect.

**Parameters**

*inOptionName* long option name \
 *inOptionLetter* short letter name \
 *inDescription* short description of the option \
 *inRequired* true if option is required \
 *ppNext* the linked list header

## Author

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