Argparse.Flag< C > Class Template Reference

Represent a flag, an option that is always only either ON or OFF, i.e. without any further value provided by the user. More...

Properties
required HashSet< string >	Names [get]
	Names the options as they will be parsed by the parser. Names of long options are prefixed with two dashes '–' Names of short options are prefixed with one dash '-' One option can represent both long and short options.
required string	Description [get, set]
	Description of the flag-like option as it should appear in help write-up.
required Action< C >	Action [get, set]
	Action to be carried out upon parsing of the flag in the input. The action is carried out each time the flag is encountered.

Detailed Description

Represent a flag, an option that is always only either ON or OFF, i.e. without any further value provided by the user.

Template Parameters

C	The cofiguration context type for the given parser, see Parser<C>

Property Documentation

Names

required HashSet<string> Argparse.Flag< C >.Names

get

Names the options as they will be parsed by the parser. Names of long options are prefixed with two dashes '–' Names of short options are prefixed with one dash '-' One option can represent both long and short options.

Exceptions

ArgumentException

Thrown when set to an empty array or the any of the provided names is in an invalid format.

---

The documentation for this class was generated from the following file:

• argsparse/Flag.cs