GNUnet  0.11.x
Data Fields
GNUNET_GETOPT_CommandLineOption Struct Reference

Definition of a command line option. More...

#include <gnunet_getopt_lib.h>

Collaboration diagram for GNUNET_GETOPT_CommandLineOption:
[legend]

Data Fields

const char shortName
 Short name of the option. More...
 
const char * name
 Long name of the option (may not be NULL) More...
 
const char * argumentHelp
 Name of the argument for the user in help text. More...
 
const char * description
 Help text for the option (description) More...
 
int require_argument
 Is an argument required? GNUNET_NO (includes optional) or GNUNET_YES (required) More...
 
int option_mandatory
 Is the presence of this option mandatory? More...
 
int option_exclusive
 Is the option exclusive? More...
 
GNUNET_GETOPT_CommandLineOptionProcessor processor
 Handler for the option. More...
 
void(* cleaner )(void *cls)
 Function to call on scls to clean up after processing all the arguments. More...
 
void * scls
 Specific closure to pass to the processor. More...
 

Detailed Description

Definition of a command line option.

Definition at line 100 of file gnunet_getopt_lib.h.

Field Documentation

◆ shortName

const char GNUNET_GETOPT_CommandLineOption::shortName

◆ name

const char* GNUNET_GETOPT_CommandLineOption::name

Long name of the option (may not be NULL)

Definition at line 110 of file gnunet_getopt_lib.h.

Referenced by GNUNET_GETOPT_run().

◆ argumentHelp

const char* GNUNET_GETOPT_CommandLineOption::argumentHelp

◆ description

const char* GNUNET_GETOPT_CommandLineOption::description

◆ require_argument

int GNUNET_GETOPT_CommandLineOption::require_argument

Is an argument required? GNUNET_NO (includes optional) or GNUNET_YES (required)

Definition at line 126 of file gnunet_getopt_lib.h.

Referenced by GNUNET_GETOPT_run().

◆ option_mandatory

int GNUNET_GETOPT_CommandLineOption::option_mandatory

Is the presence of this option mandatory?

Definition at line 131 of file gnunet_getopt_lib.h.

Referenced by GNUNET_GETOPT_option_mandatory().

◆ option_exclusive

int GNUNET_GETOPT_CommandLineOption::option_exclusive

Is the option exclusive?

Definition at line 136 of file gnunet_getopt_lib.h.

Referenced by GNUNET_GETOPT_option_exclusive().

◆ processor

GNUNET_GETOPT_CommandLineOptionProcessor GNUNET_GETOPT_CommandLineOption::processor

Handler for the option.

Definition at line 141 of file gnunet_getopt_lib.h.

Referenced by GNUNET_GETOPT_run().

◆ cleaner

void(* GNUNET_GETOPT_CommandLineOption::cleaner) (void *cls)

Function to call on scls to clean up after processing all the arguments.

Can be NULL.

Definition at line 147 of file gnunet_getopt_lib.h.

Referenced by GNUNET_GETOPT_run().

◆ scls

void* GNUNET_GETOPT_CommandLineOption::scls

Specific closure to pass to the processor.

Definition at line 152 of file gnunet_getopt_lib.h.

Referenced by format_help(), increment_value(), set_filename(), set_one(), set_string(), set_uint(), set_uint16(), and set_ulong().


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