| LibOFX
    | 
The header file for the command line option parser generated by GNU Gengetopt version 2.23 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.
| Data Structures | |
| struct | gengetopt_args_info | 
| Where the command line options are stored.  More... | |
| struct | cmdline_parser_params | 
| The additional parameters to pass to parser functions.  More... | |
| Macros | |
| #define | CMDLINE_PARSER_PACKAGE PACKAGE | 
| the program name (used for printing errors) | |
| #define | CMDLINE_PARSER_PACKAGE_NAME PACKAGE | 
| the complete program name (used for help and version) | |
| #define | CMDLINE_PARSER_VERSION VERSION | 
| the program version | |
| Functions | |
| 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) | 
| Variables | |
| const char * | gengetopt_args_info_purpose | 
| the purpose string of the program | |
| const char * | gengetopt_args_info_usage | 
| the usage string of the program | |
| const char * | gengetopt_args_info_description | 
| the description string of the program | |
| const char * | gengetopt_args_info_help [] | 
| all the lines making the help output | |
The header file for the command line option parser generated by GNU Gengetopt version 2.23 http://www.gnu.org/software/gengetopt. DO NOT modify this file, since it can be overwritten.
Definition in file ofxdump/cmdline.h.
| int cmdline_parser | ( | int | argc, | 
| char ** | argv, | ||
| struct gengetopt_args_info * | args_info | ||
| ) | 
The command line parser
| argc | the number of command line options | 
| argv | the command line options | 
| args_info | the structure where option information will be stored | 
Definition at line 423 of file ofxconnect/cmdline.c.
| 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)
| 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 | 
The command line parser (version with additional parameters - deprecated)
| 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 | 
Definition at line 445 of file ofxconnect/cmdline.c.
| int cmdline_parser_dump | ( | FILE * | outfile, | 
| struct gengetopt_args_info * | args_info | ||
| ) | 
Save the contents of the option struct into an already open FILE stream.
| outfile | the stream where to dump options | 
| args_info | the option struct to dump | 
Definition at line 303 of file ofxconnect/cmdline.c.
| int cmdline_parser_ext | ( | int | argc, | 
| char ** | argv, | ||
| struct gengetopt_args_info * | args_info, | ||
| struct cmdline_parser_params * | params | ||
| ) | 
The command line parser (version with additional 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 | 
Definition at line 429 of file ofxconnect/cmdline.c.
| int cmdline_parser_file_save | ( | const char * | filename, | 
| struct gengetopt_args_info * | args_info | ||
| ) | 
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)
| filename | the file where to save | 
| args_info | the option struct to save | 
Definition at line 364 of file ofxconnect/cmdline.c.
| void cmdline_parser_free | ( | struct gengetopt_args_info * | args_info | ) | 
Deallocates the string fields of the gengetopt_args_info structure (but does not deallocate the structure itself)
| args_info | the structure to deallocate | 
Definition at line 384 of file ofxconnect/cmdline.c.
| void cmdline_parser_init | ( | struct gengetopt_args_info * | args_info | ) | 
Initializes the passed gengetopt_args_info structure's fields (also set default values for options that have a default)
| args_info | the structure to initialize | 
Definition at line 210 of file ofxconnect/cmdline.c.
| struct cmdline_parser_params* cmdline_parser_params_create | ( | void | ) | 
Allocates dynamically a cmdline_parser_params structure and initializes all its fields to their default values
Definition at line 234 of file ofxconnect/cmdline.c.
| void cmdline_parser_params_init | ( | struct cmdline_parser_params * | params | ) | 
Initializes all the fields a cmdline_parser_params structure to their default values
| params | the structure to initialize | 
Definition at line 221 of file ofxconnect/cmdline.c.
| void cmdline_parser_print_help | ( | void | ) | 
Print the help
Definition at line 201 of file ofxconnect/cmdline.c.
| void cmdline_parser_print_version | ( | void | ) | 
Print the version
Definition at line 169 of file ofxconnect/cmdline.c.
| int cmdline_parser_required | ( | struct gengetopt_args_info * | args_info, | 
| const char * | prog_name | ||
| ) | 
Checks that all the required options were specified
| args_info | the structure to check | 
| prog_name | the name of the program that will be used to print possible errors | 
Definition at line 468 of file ofxconnect/cmdline.c.