bu_opt_desc Struct Reference

"Option description" structure. More...

#include <opt.h>

Collaboration diagram for bu_opt_desc:

Data Fields
const char *	shortopt
	"Short" option (i.e. -h for help option)
const char *	longopt
	"Long" option (i.e. –help for help option)
const char *	arg_helpstr
	Documentation describing option argument, if any (i.e. "file" in –input file)
bu_opt_arg_process_t	arg_process
	Argument processing function pointer.
void *	set_var
	Pointer to the variable or structure that collects this option's results.
const char *	help_string
	Option description.

Detailed Description

"Option description" structure.

Arrays of this structure are used to define command line options.

Definition at line 170 of file opt.h.

Field Documentation

shortopt

const char* shortopt

"Short" option (i.e. -h for help option)

Definition at line 171 of file opt.h.

longopt

const char* longopt

"Long" option (i.e. –help for help option)

Definition at line 172 of file opt.h.

arg_helpstr

const char* arg_helpstr

Documentation describing option argument, if any (i.e. "file" in –input file)

Definition at line 173 of file opt.h.

arg_process

bu_opt_arg_process_t arg_process

Argument processing function pointer.

Definition at line 174 of file opt.h.

set_var

void* set_var

Pointer to the variable or structure that collects this option's results.

Definition at line 175 of file opt.h.

help_string

const char* help_string

Option description.

Definition at line 176 of file opt.h.

---

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

• include/bu/opt.h