The header file for the command line option parser generated by GNU Gengetopt version 2.22.6 http://www.gnu.org/software/gengetopt. DO NOT modify this file, since it can be overwritten.  
More...
Go to the source code of this file.
|  | 
| int | cmdline_parser (int argc, char **argv, struct gengetopt_args_info *args_info) | 
|  | 
| int | cmdline_parser2 (int argc, char **argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required) | 
|  | 
| int | cmdline_parser_ext (int argc, char **argv, struct gengetopt_args_info *args_info, struct cmdline_parser_params *params) | 
|  | 
| int | cmdline_parser_dump (FILE *outfile, struct gengetopt_args_info *args_info) | 
|  | 
| int | cmdline_parser_file_save (const char *filename, struct gengetopt_args_info *args_info) | 
|  | 
| void | cmdline_parser_print_help (void) | 
|  | 
| void | cmdline_parser_print_version (void) | 
|  | 
| void | cmdline_parser_params_init (struct cmdline_parser_params *params) | 
|  | 
| struct cmdline_parser_params * | cmdline_parser_params_create (void) | 
|  | 
| void | cmdline_parser_init (struct gengetopt_args_info *args_info) | 
|  | 
| void | cmdline_parser_free (struct gengetopt_args_info *args_info) | 
|  | 
| int | cmdline_parser_required (struct gengetopt_args_info *args_info, const char *prog_name) | 
|  | 
The header file for the command line option parser generated by GNU Gengetopt version 2.22.6 http://www.gnu.org/software/gengetopt. DO NOT modify this file, since it can be overwritten. 
- Author
- GNU Gengetopt by Lorenzo Bettini 
Definition in file cmdline.h.
The command line parser 
- Parameters
- 
  
    | argc | the number of command line options |  | argv | the command line options |  | args_info | the structure where option information will be stored |  
 
- Returns
- 0 if everything went fine, NON 0 if an error took place 
Definition at line 304 of file cmdline.c.
Referenced by main().
 
 
      
        
          | int cmdline_parser2 | ( | int | argc, | 
        
          |  |  | char ** | argv, | 
        
          |  |  | struct gengetopt_args_info * | args_info, | 
        
          |  |  | int | override, | 
        
          |  |  | int | initialize, | 
        
          |  |  | int | check_required | 
        
          |  | ) |  |  | 
      
 
The command line parser (version with additional parameters - deprecated) 
- Parameters
- 
  
    | argc | the number of command line options |  | argv | the command line options |  | args_info | the structure where option information will be stored |  | override | whether to override possibly already present options |  | initialize | whether to initialize the option structure my_args_info |  | check_required | whether to check that all required options were provided |  
 
- Returns
- 0 if everything went fine, NON 0 if an error took place 
- Deprecated:
- use cmdline_parser_ext() instead 
Definition at line 326 of file cmdline.c.
Referenced by cmdline_parser().
 
 
Save the contents of the option struct into an already open FILE stream. 
- Parameters
- 
  
    | outfile | the stream where to dump options |  | args_info | the option struct to dump |  
 
- Returns
- 0 if everything went fine, NON 0 if an error took place 
Definition at line 226 of file cmdline.c.
Referenced by cmdline_parser_file_save().
 
 
The command line parser (version with additional parameters) 
- Parameters
- 
  
    | argc | the number of command line options |  | argv | the command line options |  | args_info | the structure where option information will be stored |  | params | additional parameters for the parser |  
 
- Returns
- 0 if everything went fine, NON 0 if an error took place 
Definition at line 310 of file cmdline.c.
 
 
Save the contents of the option struct into a (text) file. This file can be read by the config file parser (if generated by gengetopt) 
- Parameters
- 
  
    | filename | the file where to save |  | args_info | the option struct to save |  
 
- Returns
- 0 if everything went fine, NON 0 if an error took place 
Definition at line 263 of file cmdline.c.
 
 
Initializes the passed gengetopt_args_info structure's fields (also set default values for options that have a default) 
- Parameters
- 
  
    | args_info | the structure to initialize |  
 
Definition at line 152 of file cmdline.c.
 
 
      
        
          | void cmdline_parser_print_help | ( | void |  | ) |  | 
      
 
 
      
        
          | void cmdline_parser_print_version | ( | void |  | ) |  | 
      
 
 
Checks that all the required options were specified 
- Parameters
- 
  
    | args_info | the structure to check |  | prog_name | the name of the program that will be used to print possible errors |  
 
- Returns
Definition at line 349 of file cmdline.c.