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...
#include <stdio.h>
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.23 http://www.gnu.org/software/gengetopt. DO NOT modify this file, since it can be overwritten.
- Author
- GNU Gengetopt
◆ CMDLINE_PARSER_PACKAGE
#define CMDLINE_PARSER_PACKAGE "pcap2mjr" |
the program name (used for printing errors)
◆ CMDLINE_PARSER_PACKAGE_NAME
#define CMDLINE_PARSER_PACKAGE_NAME "pcap2mjr" |
the complete program name (used for help and version)
◆ CMDLINE_PARSER_VERSION
#define CMDLINE_PARSER_VERSION "1.0.0" |
◆ cmdline_parser()
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
◆ cmdline_parser2()
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
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
◆ cmdline_parser_dump()
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
◆ cmdline_parser_ext()
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
◆ cmdline_parser_file_save()
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
◆ cmdline_parser_free()
Deallocates the string fields of the gengetopt_args_info structure (but does not deallocate the structure itself)
- Parameters
-
args_info | the structure to deallocate |
◆ cmdline_parser_init()
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 |
◆ cmdline_parser_params_create()
◆ cmdline_parser_params_init()
Initializes all the fields a cmdline_parser_params structure to their default values
- Parameters
-
params | the structure to initialize |
◆ cmdline_parser_print_help()
void cmdline_parser_print_help |
( |
void |
| ) |
|
◆ cmdline_parser_print_version()
void cmdline_parser_print_version |
( |
void |
| ) |
|
◆ cmdline_parser_required()
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
◆ gengetopt_args_info_description
const char* gengetopt_args_info_description |
|
extern |
the description string of the program
◆ gengetopt_args_info_help
const char* gengetopt_args_info_help[] |
|
extern |
all the lines making the help output
◆ gengetopt_args_info_purpose
const char* gengetopt_args_info_purpose |
|
extern |
the purpose string of the program
◆ gengetopt_args_info_usage
const char* gengetopt_args_info_usage |
|
extern |
the usage string of the program