parseoptsDefinition Struct Reference

Structure for defining possible command line options. More...

#include <parseOpts.h>

Data Fields

char * description
int hasArgs
char * name
int number
char * shortName
int toolMask

Detailed Description

Structure for defining possible command line options.

Definition at line 193 of file parseOpts.h.

Field Documentation

char* parseoptsDefinition::description

Textual description of function

Definition at line 197 of file parseOpts.h.

int parseoptsDefinition::hasArgs

Boolean value indicating whether the option takes an argument. Use OPTION_HAS_ARGS or OPTION_NO_ARGS.

Definition at line 199 of file parseOpts.h.

char* parseoptsDefinition::name

Long option ( eg. --x ), without leading --.

Definition at line 196 of file parseOpts.h.

int parseoptsDefinition::number

Identification number, which is returned from getopt(). Please no magic numbers, use one of the option identification defines.

Definition at line 195 of file parseOpts.h.

char* parseoptsDefinition::shortName

Short option ( eg. -x ), without leading -. Not used.

Definition at line 198 of file parseOpts.h.

int parseoptsDefinition::toolMask

Bitmask defining which tools this option applies to, see TOOL_* defines above for options.

Definition at line 200 of file parseOpts.h.

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