An option which can be parsed by an OFOptionsParser. More...

#include <ObjFW/ObjFW.h>

Public Attributes
OFUnichar	shortOption

OFString *__unsafe_unretained	longOption

signed char	hasArgument

bool *	isSpecifiedPtr

OFString __autoreleasing	argumentPtr

Detailed Description

An option which can be parsed by an OFOptionsParser.

Member Data Documentation

◆ argumentPtr

OFString* __autoreleasing* OFOptionsParserOption::argumentPtr

An optional pointer to an OFString * that is set to the argument specified for the option or nil for no argument.

◆ hasArgument

signed char OFOptionsParserOption::hasArgument

Whether the option takes an argument.

0 means it takes no argument.
1 means it takes a required argument.
-1 means it takes an optional argument.
All other values are invalid and will throw an OFInvalidArgumentException.

◆ isSpecifiedPtr

bool* OFOptionsParserOption::isSpecifiedPtr

An optional pointer to a bool that is set to whether the option has been specified.

◆ longOption

OFString* __unsafe_unretained OFOptionsParserOption::longOption

The long version (e.g. --verbose) of the option or nil for none.

◆ shortOption

OFUnichar OFOptionsParserOption::shortOption

The short version (e.g. -v) of the option or \0 for none.

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

src/OFOptionsParser.h