coan  6.0.1
A C/C++ Configuration Analyzer
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
option Struct Reference

Info structure for an option for getopt_long(). More...

#include <get_options.h>

Public Attributes

const char * name
 The name of the option.
 
int has_arg
 Can the option take an argument? One of: More...
 
int * flag
 Mode flag. More...
 
int val
 Value to be returned or stored by getopt_long(). More...
 

Detailed Description

Info structure for an option for getopt_long().

Definition at line 57 of file get_options.h.

Member Data Documentation

int* option::flag

Mode flag.

nullptr here makes getopt_long() return the field val if this option is matched. Non-null makes getopt_long() return 0 if any option is matched, and set the int addressed by flag = val if this option is matched, otherwise leaving it unchanged.

Definition at line 76 of file get_options.h.

int option::has_arg

Can the option take an argument? One of:

  • no_argument
    • required_argument
    • optional argument

Definition at line 66 of file get_options.h.

int option::val

Value to be returned or stored by getopt_long().

Value to be returned or stored by getopt_long() if this option is matched (depending on flag).

Definition at line 82 of file get_options.h.


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